Note: There is a newer version (1.0.2) of this package available. Click here to view docs for the latest version.
Module concuruserprovisioning
edotco/concuruserprovisioning
0.1.0
SAP Concur concuruserprovisioning Connector
A Ballerina connector for SAP Concur concuruserprovisioning API.
Overview
This connector provides integration with SAP Concur's concuruserprovisioning service.
Usage
import ballerinax/sap.concur.concuruserprovisioning;
Generated from official SAP Concur OpenAPI specification.
Clients
concuruserprovisioning: Client
Isolated
Create and update user's profile across Concur products. UPS allows requestors to create or update user profiles in bulk or individually.
Constructor
Gets invoked to initialize the connector.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://us.api.concursolutions.com/profile/v4" - URL of the target service
userReplace
Isolated FunctionRemote Function
Replace User
userDelete
Isolated FunctionRemote Function
Delete User
Parameters
- id string - User Id
Return Type
- error? - Service Unavailable
userPatch
Isolated FunctionRemote Function
Patch User
schemaIdGet
Isolated FunctionRemote Function
Get a schema.
Parameters
- id string - Schema Id
Return Type
- error? - Service Unavailable
resourcetypesGetId
Isolated FunctionRemote Function
Get Resource Type
Parameters
- id string - Resource Type Id
Return Type
- error? - Service Unavailable
schemaGet
Isolated FunctionRemote Function
Get all supported schemas.
Return Type
- error? - Service Unavailable
bulkProvisionCreate
Isolated FunctionRemote Function
function bulkProvisionCreate(BulkRequest payload, map<string|string[]> headers, *BulkProvisionCreateQueries queries) returns ProvisionStatus|errorCreate a bulk provisioning request.
Parameters
- payload BulkRequest - Bulk Create
- queries *BulkProvisionCreateQueries - Queries to be sent with the request
Return Type
- ProvisionStatus|error - Service Unavailable
provisionsIdStatusGet
Isolated FunctionRemote Function
function provisionsIdStatusGet(string id, map<string|string[]> headers, *ProvisionsIdStatusGetQueries queries) returns ProvisionStatus|errorGet the status of a provisioning request.
Parameters
- id string - Provision Id
- queries *ProvisionsIdStatusGetQueries - Queries to be sent with the request
Return Type
- ProvisionStatus|error - Service Unavailable
serviceproviderconfigGet
Isolated FunctionRemote Function
function serviceproviderconfigGet(map<string|string[]> headers) returns ServiceProviderConfig|errorService provider's configuration details
Return Type
- ServiceProviderConfig|error - Service Unavailable
resourcetypesGet
Isolated FunctionRemote Function
Get types of resources supported
Return Type
- error? - Service Unavailable
userCreate
Isolated FunctionRemote Function
Create User
Parameters
- payload User - User
Records
concuruserprovisioning: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- Authorization string -
concuruserprovisioning: AuthorizedApproverLimitExtension
Fields
- costObjectApprover? AuthorizedApproverLimitExtension_authorizedApprover[] - A list of Approver Limit Config associated with the Cost Object Approver type.
concuruserprovisioning: AuthorizedApproverLimitExtension_authorizedApprover
Fields
- approvalGroup? string - Group to be associated with the approval rights; if blank, resolves to the global group
- approvalLimit? decimal - The upper bound of the approval authority.
- approvalType? string - Options for changing Expense, Invoice, Request, or Purchase Request delegate options.
- exceptionApprovalAuthority? boolean - Indicate whether this approval config has the exception authority.
- level? int - The approval level of the user. This denotes the sequential order in which the user(s) will approve the report or request.
- reimbursementCurrency? string - Valid three digit currency code in the list of system reimbursement currencies.
concuruserprovisioning: BulkProvisionCreateQueries
Represents the Queries record for the operation: bulkProvisionCreate
Fields
- companyId? string - Company Id, optional for callers with bearer token
concuruserprovisioning: BulkRequest
Fields
- schemas? ("urn:ietf:params:scim:api:messages:2.0:BulkRequest")[] -
- Operations? BulkRequest_Operations[] -
concuruserprovisioning: BulkRequest_Operations
Fields
- data? User -
- method? "POST"|"PUT"|"PATCH" - HTTP Method
- bulkId? string - Transient identifier of newly created resource, unique within a bulk request. REQUIRED when "method" is "POST"
- path? "/Users" - Resource Path
concuruserprovisioning: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
concuruserprovisioning: EnterpriseUser
Fields
- companyId string - Concur ID of the company
- costCenter? string - employee cost center for product
- department? string - Client supplied department name
- division? string - Client supplied division name
- employeeNumber? string - Client supplied employee's number within the company, unique for the company
- leavesOfAbsence? EnterpriseUser_leavesOfAbsence[] - Leaves of absence for the user
- legalEntity? string - Legal entity the user belongs to
- manager? EnterpriseUser_manager - The manager of this user
- organization? string - Company name
- startDate string - Start Date, in YYYY-MM-DD'T'hh:mm:ss'Z' format. Date range is from 1900-01-01 to 2079-06-06.
- terminationDate? string - Termination Date, in YYYY-MM-DD'T'hh:mm:ss'Z' format. If the employee is terminated, this can also be used to calculate the data retention period. Date range is from 1900-01-01 to 2079-06-06.
concuruserprovisioning: EnterpriseUser_leavesOfAbsence
Fields
- endDate? string - Last date of the leave of absence
- startDate string - First date of the leave of absence
- 'type? "voluntary"|"mandatory" - Type of the leave of absence
concuruserprovisioning: EnterpriseUser_manager
The manager of this user
Fields
- \$ref? string - The URI of the SCIM resource representing the referenced user.
- displayName? string - The referenced user's display name
- employeeNumber? string - The referenced user's employee number
- value string - The referenced user's UUID
concuruserprovisioning: ExpenseUserPreferenceExtension
Fields
- allowAutoCreateTripReport? "No"|"Trip"|"Calendar"|"Default" - Allow auto create trip report.
- allowCreditCardTransArrivalEmails? boolean - Allow Credit Card Transaction Arrival Notification Emails, defaulted to true.
- allowReceiptImageAvailEmails? boolean - Send email when faxed receipts are successfully received, defaulted to true.
- autoAddTripCardTransOnReport? boolean - Add company card transactions within trip dates to 1 click expense report.
- defaultReportPrintFormat? "RECEIPTS"|"DETAILED"|"FAX" - Default expense report print type.
- enableOcrForEmail? boolean - Enable OCR for Email.
- enableOcrForUi? boolean - Enable OCR for the UI.
- enableTripBasedAssistant? boolean - Enable Trip-based Expense Assistant.
- expenseAuditRequired? "NEVER"|"REQUIRED"|"ALWAYS" - Expense Audit is required.
- processorReportAccess? "All reports excluding returned"|"All reports including returned"|"All reports Pending processor and above" - Report access for processor roles (Expense Processor, Expense Processor Audit, Expense Processor Manager)
- promptForCardTransactionsOnReport? boolean - Prompt for Company Card Transactions when creating a new report, defaulted to true.
- promptForReportPrintFormat? boolean - Always prompt for the report format before printing.
- showExpenseOnReport? "ALL"|"PARENT"|"NOTHING" - Show expenses on detailed report.
- showImagingIntro? boolean - Display imaging introduction, defaulted to true.
- showInstructHelpPanel? boolean - Display instructional help, defaulted to true.
- showTotalOnReport? boolean - Show Report Totals on Detailed Report.
- useQuickItinAsDefault? boolean - Use quick itinerary as default.
concuruserprovisioning: InvoicePreferenceExtension
Fields
- autoOpenImage? boolean - Auto Open Image
- displayInlineImage? boolean - Display Image Inline
- emailOnFaxImageAvailablePaymentRequest? boolean - Send email when a fax image is available for a payment request
- emailOnPurchasingAssigned? boolean - Send email when a request is assigned to purchasing
- emailOnPurchasingSendBack? boolean - Send email when a request is sent back from purchasing
- promptNewLineItemsPaymentRequest? boolean - Prompt a user with a window to create new line items when creating a new payment request
concuruserprovisioning: PatchOp
Fields
- schemas? ("urn:ietf:params:scim:api:messages:2.0:PatchOp")[] -
- Operations? PatchOp_Operations -
concuruserprovisioning: PatchOp_Operations
Fields
- op? "add"|"replace"|"remove" -
- path? string - Optional for add/replace, but required for remove operations
- value? record {} - https://datatracker.ietf.org/doc/html/rfc7644#section-3-5-2
concuruserprovisioning: PayrollExtension
Fields
- adp? PayrollExtension_adp - A user's ADP settings
concuruserprovisioning: PayrollExtension_adp
A user's ADP settings
Fields
- companyCode string - The company code for the employee within ADP.
- deductionCode string - The deduction code for the employee within ADP.
- employeeFileNumber string - The identifier for the employee within ADP, also known as the "Employee File Number".
concuruserprovisioning: ProvisionsIdStatusGetQueries
Represents the Queries record for the operation: provisionsIdStatusGet
Fields
- startIndex? int - The 1-based index of the first operation in the set of operations
- count? int - The number of operations to be returned in response
- attributes? "operations" - Additional attributes to include in response
- state? "success"|"failed"|"pending" - Filter operations to be returned in response based on status
concuruserprovisioning: ProvisionStatus
Fields
- id string - Unique identifier (uuid) for the provisioning request
- itemsPerPage? int - The number of operations returned in current response
- operations? ProvisionStatus_operations[] - Status of each operation of the provisioning request
- operationsCount ProvisionStatus_operationsCount - Count of operations in a provision request
- startIndex? int - The 1-based index of the first operation in the current set of operations
- status ProvisionStatus_status_2 - Status of the provision request
- totalResults? int - The total number of operations in a bulk provisioning request
concuruserprovisioning: ProvisionStatus_extensions
Fields
- messages? ProvisionStatus_messages - Additional messages in case of errors / warnings
- name string - Extension Name
- status ProvisionStatus_status - Status of the operation
concuruserprovisioning: ProvisionStatus_messages
Additional messages in case of errors / warnings
Fields
- code string - Message Code
- message? string - Message description
- schemaPath? string - Relative schema path of attribute
- 'type "error"|"warning" - Message Type
concuruserprovisioning: ProvisionStatus_operations
Fields
- bulkId? string - Transient identifier of newly created resource, unique within a bulk request
- extensions? ProvisionStatus_extensions[] - extensions' status
- id string - Identifier of the operation (generated by provisioning service)
- 'resource? ProvisionStatus_resource - resource details
- status ProvisionStatus_status_1 - Status of the operation
concuruserprovisioning: ProvisionStatus_operationsCount
Count of operations in a provision request
Fields
- failed decimal - Is operation failed?
- pending decimal - Is operation pending?
- success decimal - Is operation successful?
- total decimal - All operations
concuruserprovisioning: ProvisionStatus_resource
resource details
Fields
- id? string - Unique Identifier (UUID) of the resource
- 'type? "User" - resource type
concuruserprovisioning: ProvisionStatus_status
Status of the operation
Fields
- code? string - http status code
- completed boolean - Is processing extension completed?
- result? "success"|"error"|"no-op"|"not-processed" - result of action on resource
- success? boolean - Is processing extension success?
concuruserprovisioning: ProvisionStatus_status_1
Status of the operation
Fields
- completed boolean - Is provisioning completed?
- success? boolean - Is provisioning success?
concuruserprovisioning: ProvisionStatus_status_2
Status of the provision request
Fields
- completed boolean - Is provisioning completed?
- success? boolean - Is provisioning successful?
concuruserprovisioning: ServiceProviderConfig
Fields
- schemas? ("urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig")[] -
- authenticationSchemes? ServiceProviderConfig_authenticationSchemes -
- sort? ServiceProviderConfig_sort -
- changePassword? ServiceProviderConfig_sort -
- patch? ServiceProviderConfig_sort -
- filter? ServiceProviderConfig_filter -
- etag? ServiceProviderConfig_sort -
- meta? ServiceProviderConfig_meta -
- bulk? ServiceProviderConfig_bulk -
concuruserprovisioning: ServiceProviderConfig_authenticationSchemes
Fields
- name? string -
- description? string -
- specUri? string -
- 'type? string -
concuruserprovisioning: ServiceProviderConfig_bulk
Fields
- supported? boolean -
- maxOperations? int -
- maxPayloadSize? int -
concuruserprovisioning: ServiceProviderConfig_filter
Fields
- supported? boolean -
- maxResults? int -
concuruserprovisioning: ServiceProviderConfig_meta
Fields
- resourceType string(default "ServiceProviderConfig") -
concuruserprovisioning: ServiceProviderConfig_sort
Fields
- supported? boolean -
concuruserprovisioning: SpendApprover
Fields
- approverType? SpendApprover_approverType[] - A list of Approvers associated with the Approver's type.
concuruserprovisioning: SpendApprover_approver
The user reference for the approver
Fields
- \$ref? string - The URI reference for the user
- displayName? string - The username for the user
- employeeNumber string - The employee number for the user
- value? record {} - The internal UUID identifier for the user
concuruserprovisioning: SpendApprover_approverType
Fields
- approver? SpendApprover_approver - The user reference for the approver
- primary boolean - The value for indicating whether the associated user is primary approver
concuruserprovisioning: SpendDelegate
Fields
- delegateProdCode? SpendDelegate_delegateProdCode[] - A list of Delegate associated with the Delegate's product code.
concuruserprovisioning: SpendDelegate_delegate
UserReference for the delegate
Fields
- \$ref? string - The URI reference for the user
- displayName? string - The username for the user
- employeeNumber string - The employee number for the user
- value? record {} - The internal UUID identifier for the user
concuruserprovisioning: SpendDelegate_delegateProdCode
Fields
- canApprove? boolean - Determines if delegate can approve
- canPrepare? boolean - Determines if delegate can prepare
- canPrepareForApproval? boolean - Determines if delegate can prepare for approval
- canReceiveApprovalEmail? boolean - Determines if delegate can receive approval emails
- canReceiveEmail? boolean - Determines if delegate can receive emails
- canSubmit? boolean - Determines if delegate can submit
- canSubmitTravelRequest? boolean - Determines if delegate can submit travel request
- canUseBi? boolean - Determines if delegate can use BI
- canViewReceipt? boolean - Determines if delegate can view receipts
- delegate SpendDelegate_delegate - UserReference for the delegate
- temporaryDelegation? SpendDelegate_temporaryDelegation - Determines if delegate can temporarily approve
concuruserprovisioning: SpendDelegate_temporaryDelegation
Determines if delegate can temporarily approve
Fields
- temporaryDelegationFromDate? string - Start date for delegates temporary approval permissions. Valid ISO 8601 Date
- temporaryDelegationToDate? string - End date for delegates temporary approval permissions. Valid ISO 8601 Date
concuruserprovisioning: SpendRole
Fields
- roles? SpendRole_roles[] - Expense Roles for Employee
concuruserprovisioning: SpendRole_roles
Fields
- roleGroups? record {}[] - Group(s) to be associated with the Expense Role
- roleName record {} - Expense Role for Employee
concuruserprovisioning: SpendUser
Fields
- biHierarchy? SpendUser_biHierarchy - The object containing the long code and the sync guid of the last list item in Reporting Hierarchy. This is only for UAC(Unified Analytics of Concur).
- biManager? SpendUser_biManager - The UUID of the Reporting Manager
- budgetCountryCode? string - Valid ISO 3166 country code for Budget
- cashAdvanceAccountCode string - Valid cash advance account code
- country string - Valid ISO 3166 country code
- ledgerCode? string - Ledger code to associate with the user
- locale string - Valid locale from the list of configured locales as defined in [RFC5646]
- nonEmployee? boolean - A Boolean value indicating whether the User is a NonEmployee
- reimbursementCurrency string - Valid three digit or letter currency code in the list of system reimbursement currencies
- reimbursementType? record {} - The reimbursement type for the user
- schemaCustomData? SpendUser_schemaCustomData[] - The Custom Data associated with this user
- stateProvince? string - Valid ISO sub country code
- testEmployee? boolean - A Boolean value indicating whether the User is a test user. Can't be modified after the user is created. Can only be set at creation.
concuruserprovisioning: SpendUser_biHierarchy
The object containing the long code and the sync guid of the last list item in Reporting Hierarchy. This is only for UAC(Unified Analytics of Concur).
Fields
- code? string - The long code of the last list item in Reporting Hierarchy. This is only for UAC(Unified Analytics of Concur).
- href? string - The URI to the last list item in Reporting Hierarchy. This is only for UAC(Unified Analytics of Concur).
- syncGuid? string - The sync guid of the last list item in Reporting Hierarchy. This is only for UAC(Unified Analytics of Concur).
concuruserprovisioning: SpendUser_biManager
The UUID of the Reporting Manager
Fields
- \$ref? string - The URI reference for the user
- displayName? string - The username for the user
- employeeNumber string - The employee number for the user
- value? record {} - The internal UUID identifier for the user
concuruserprovisioning: SpendUser_schemaCustomData
Fields
- href string - The list service endpoint to fetch the specific item information.
- id string - custom1 - custom22, orgUnit1 - orgUnit6
- syncGuid string - The sync_guid value of the custom field
- value string - Value of the custom field - For list = List Item Code
concuruserprovisioning: TravelUser
Fields
- customFields? TravelUser_customFields[] - user can set values to custom data fields
- gender? string - gender of travel user
- groups? int[] - List of user groups that user belongs to for certain permissions
- manager? TravelUser_manager - Travel approver of this user
- name TravelUser_name -
- orgUnit? string - The name of the org unit user belongs to
- permissions? TravelUser_permissions - Travel permissions for this user
- ruleClass TravelUser_ruleClass - Defines the rule class for the travel user either id or name should be provided
- travelCrsName string - The name of the profile in the GDS system
- travelNameRemark? string - travel name remark
- xmlProfileSyncId? string - client-assigned Travel user identifier that allows the user profile to be synchronized with other vendors
concuruserprovisioning: TravelUser_customFields
Fields
- name? string - Name of the custom field
- value? string - Value for the given custom field
concuruserprovisioning: TravelUser_manager
Travel approver of this user
Fields
- employeeNumber? string - The referenced user's employee number
- value? string - The referenced user's UUID
concuruserprovisioning: TravelUser_name
Fields
- familyName? string - travel family name of user
- givenName? string - travel given name of user
- hasNoMiddleName? boolean - flag for if user has no middle name
- honorificSuffix? string - travel honorific suffix of user
- middleName? string - travel middle name of user
- namePrefix? string - travel name prefix of user
concuruserprovisioning: TravelUser_permissions
Travel permissions for this user
Fields
- OpenBookingUser? boolean - enable or disable this permission
- ProfileUser? boolean - enable or disable this permission
- TravelUser? boolean - enable or disable this permission
concuruserprovisioning: TravelUser_ruleClass
Defines the rule class for the travel user either id or name should be provided
Fields
- id? int - valid Rule class id to be assigned
- name? string - valid name of rule class
concuruserprovisioning: User
Fields
- active boolean - A Boolean value indicating whether the User is active.
- addresses? User_addresses[] - Physical mailing addresses for the User.
- dateOfBirth? string - The user's date of birth, in YYYY-MM-DD format
- displayName? string - The name of the User, suitable for display to end-users.
- emails? User_emails[] - Email addresses for the user.
- emergencyContacts? User_emergencyContacts[] - Emergency Contact information for the User.
- entitlements? ("Expense"|"Invoice"|"Locate"|"Request"|"Travel"|"Analytics"|"Unified Analytics")[] - The features enabled for the user
- externalId? string - User identifier from the provisioning client
- id string - Unique identifier for the user - a uuid
- localeOverrides? User_localeOverrides - Support for users who want to override locale settings
- meta? User_meta - Read only information about the User
- name User_name - The user's name
- nickName? string - The casual way to address the user in real life, e.g., 'Bob' or 'Bobby' instead of 'Robert'. This attribute SHOULD NOT be used to represent a User's username (e.g., 'bjensen' or 'mpepperidge').
- phoneNumbers? User_phoneNumbers[] - Phone numbers for the user
- preferredLanguage string - Indicates the User's preferred written or spoken language. Generally used for selecting a localized user interface
- timezone string - The User's time zone in the 'Olson' time zone database format, e.g., 'America/Los_Angeles'.
- title? string - user's job title in the company
- urn\:ietf\:params\:scim\:schemas\:extension\:enterprise\:2\.0\:Payroll? PayrollExtension -
- urn\:ietf\:params\:scim\:schemas\:extension\:enterprise\:2\.0\:User? EnterpriseUser -
- urn\:ietf\:params\:scim\:schemas\:extension\:spend\:2\.0\:Approver? SpendApprover -
- urn\:ietf\:params\:scim\:schemas\:extension\:spend\:2\.0\:ApproverLimit? AuthorizedApproverLimitExtension -
- urn\:ietf\:params\:scim\:schemas\:extension\:spend\:2\.0\:Delegate? SpendDelegate -
- urn\:ietf\:params\:scim\:schemas\:extension\:spend\:2\.0\:InvoicePreference? InvoicePreferenceExtension -
- urn\:ietf\:params\:scim\:schemas\:extension\:spend\:2\.0\:Role? SpendRole -
- urn\:ietf\:params\:scim\:schemas\:extension\:spend\:2\.0\:User? SpendUser -
- urn\:ietf\:params\:scim\:schemas\:extension\:spend\:2\.0\:UserPreference? ExpenseUserPreferenceExtension -
- urn\:ietf\:params\:scim\:schemas\:extension\:spend\:2\.0\:WorkflowPreference? WorkflowPreferenceExtension -
- urn\:ietf\:params\:scim\:schemas\:extension\:travel\:2\.0\:User? TravelUser -
- userName string - The name that can be used to login to CTE
concuruserprovisioning: User_addresses
Fields
- country? string - A two-letter country code defined in ISO 3166-1 alpha-2
- locality? string - The city or locality.
- postalCode? string - The zip code or postal code.
- region? string - The state or region.
- streetAddress? string - The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines.
- 'type? "work"|"home"|"other"|"billing"|"bank"|"shipping" - A label indicating the function of the address, e.g., 'work' or 'home'.
concuruserprovisioning: User_emails
Fields
- notifications? boolean - Notifications opt-in for emails
- 'type "work"|"home"|"work2"|"other"|"other2" - A label indicating the function of the address, e.g., 'work' or 'home'.
- value string - Email address value
- verified? boolean - flag to note which email has been verified by the user.
concuruserprovisioning: User_emergencyContacts
Fields
- country? string - A two-letter country code defined in ISO 3166-1 alpha-2
- emails? string[] - Emails of the contact
- locality? string - The city or locality.
- name string - Contact name.
- phones? string[] - Phone numbers of the contact
- postalCode? string - The zip code or postal code.
- region? string - The state or region.
- relationship "Spouse"|"Brother"|"Parent"|"Sister"|"Life Partner"|"Other" - Emergency contact relationship.
- streetAddress? string - The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines.
concuruserprovisioning: User_localeOverrides
Support for users who want to override locale settings
Fields
- displayNameFormat? User_localeOverrides_displayNameFormat - templates containing arrays of name field keys used for formatting users' names
- preference24Hour "H:mm AM/PM"|"hh:mm" - preferred time format for the user
- preferenceCurrencySymbolLocation "BeforeAmount"|"AfterAmount" - preferred currency symbol location for the user
- preferenceDateFormat "mm/dd/yyyy"|"mm.dd.yyyy"|"mm-dd-yyyy"|"dd/mm/yyyy"|"dd.mm.yyyy"|"dd-mm-yyyy"|"yyyy/mm/dd"|"yyyy.mm.dd"|"yyyy-mm-dd" - preferred date format for the user
- preferenceDefaultCalView "day"|"week"|"month" - preferred default calendar view for the user
- preferenceDistance? "mile"|"km" - preferred distance metric
- preferenceEndDayViewHour int - preferred hour setting for the end of day, 0-23
- preferenceFirstDayOfWeek "Sunday"|"Monday"|"Tuesday"|"Wednesday"|"Thursday"|"Friday"|"Saturday" - preferred first day of the week for the user
- preferenceHourMinuteSeparator ":"|"." - preferred separator between hour and minute
- preferenceNegativeCurrencyFormat? "-100"|"(100)" - preferred negative currency format for the user
- preferenceNegativeNumberFormat? "-100"|"(100)" - preferred negative number format for the user
- preferenceNumberFormat "1,000.00"|"1.000,00"|"1 000,00"|"1'000.00"|"1'000,00" - preferred number format for the user
- preferenceStartDayViewHour int - preferred hour setting for the start of day, 0-23
concuruserprovisioning: User_localeOverrides_displayNameFormat
templates containing arrays of name field keys used for formatting users' names
Fields
- withNickName? string[] - preferred name format template for when nickName is defined
- withoutNickName? string[] - preferred name format template for when nickName is not defined
concuruserprovisioning: User_meta
Read only information about the User
Fields
- created? string - Timestamp of creation
- lastModified? string - Timestamp of change
- location? string - URL of resource
- resourceType? string - Type of schema
- version? int - Number of changes
concuruserprovisioning: User_name
The user's name
Fields
- academicTitle? "Dr."|"Doctor"|"Prof."|"Professor"|"Prof. Dr."|"Professor Doctor"|"B.A."|"Bachelor of Arts"|"MBA"|"Master of Business Administration"|"Ph.D"|"Doctor of Philosophy" - Title signifying level of academic achievement
- familyName string - The family name of the User, or last name in most Western languages (e.g., 'Jensen' given the full name 'Ms. Barbara J Jensen, III').
- familyNamePrefix? string - The family name prefix of the User (e.g. 'van' given the full name 'Vincent van Gogh')
- formatted? string - The full name, formatted for display (e.g., 'Jensen, Barbara Jane').
- givenName string - The given name of the User, or first name in most Western languages (e.g., 'Barbara' given the full name 'Ms. Barbara J Jensen, III').
- honorificPrefix? string - The honorific prefix(es) of the User, or title in most Western languages (e.g., 'Ms.' given the full name 'Ms. Barbara J Jensen, III').
- honorificSuffix? string - The honorific suffix(es) of the User, or suffix in most Western languages (e.g., 'III' given the full name 'Ms. Barbara J Jensen, III').
- legalName? string - The legal name of the User (e.g., 'Jane' given the full name 'Ms. Barbara J Jensen, III').
- middleInitial? string - middle initial, if the user has a middle name
- middleName? string - The middle name(s) of the User (e.g., 'Jane' given the full name 'Ms. Barbara J Jensen, III').
concuruserprovisioning: User_phoneNumbers
Fields
- display? string - Phone number canonicalized to RFC3966 format
- issuingCountry? string - Issuing country for mobile devices (type=mobile); two-letter code per ISO 3166-1 alpha-2
- notifications? boolean - LNA Opt-in for mobile devices (type=mobile)
- primary? boolean - Primary device for mobile devices (type=mobile)
- 'type "work"|"home"|"mobile"|"fax"|"pager"|"other"|"work2" - A label indicating the phone number's function, e.g., 'work', 'home'.
- value string - Phone number value
- workExtension? string - Extension for work phone (type=work)
concuruserprovisioning: WorkflowPreferenceExtension
Fields
- emailAwaitApprovalOnCashAdvance? boolean - Send email when a cash advance is awaiting approval, defaulted to true.
- emailAwaitApprovalOnPayment? boolean - Send email when a payment is awaiting approval, defaulted to true.
- emailAwaitApprovalOnReport? boolean - Send email when a report is awaiting approval, defaulted to true.
- emailAwaitApprovalOnTravelRequest? boolean - Send email when a travel request is awaiting approval, defaulted to true.
- emailOnPurchaseRequestAwaitApproval? boolean - Send email when the purchase request is awaiting approval, defaulted to true.
- emailOnPurchaseRequestStatusChange? boolean - Send email when the purchase request status changes, defaulted to true.
- emailStatusChangeOnCashAdvance? boolean - Send email when the cash advance status changes, defaulted to true.
- emailStatusChangeOnPayment? boolean - Send email when the payment status changes, defaulted to true.
- emailStatusChangeOnReport? boolean - Send email when the report status changes, defaulted to true.
- emailStatusChangeOnTravelRequest? boolean - Send email when the travel request status changes, defaulted to true.
- promptForApproverOnPaymentSubmit? boolean - Prompt for approver when submitting a payment, defaulted to false.
- promptForApproverOnReportSubmit? boolean - Prompt for approver when submitting a report, defaulted to false.
- promptForApproverOnTravelRequestSubmit? boolean - Prompt for approver when submitting a travel request, defaulted to false.
- promptForPurchaseRequestApproverOnSubmit? boolean - Prompt for approver when submitting a purchase request, defaulted to false.