POST v2/users

Action will save the user into the FreightPOP using SCIM.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/v2/users

Sandbox Url: https://sandbox-api.freightpop.com/v2/users

Request Information

URI Parameters

None.

Body Parameters

ScimUser

Name	Description	Type	Additional information
schemas		Collection of string	None.
id	Defines the FreightPop user id.	string	Defines the FreightPop user id.
externalId	Defines external user id of the user.	string	Defines external user id of the user.
userName		string	None.
name		ScimName	None.
emails	Defines the emails of the user	Collection of ScimEmail	Defines the emails of the user
phoneNumbers	Defines the phone numbers of the user	Collection of ScimPhoneNumbers	Defines the phone numbers of the user
active	Defines either the user is active of inactive	boolean	Defines either the user is active of inactive
password		string	None.
groups	Defines the groups of user	Collection of ScimGroups	Defines the groups of user
meta		ScimMeta	None.

Request Formats

application/json, text/json

Sample:

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "sample string 1",
  "externalId": "sample string 2",
  "userName": "sample string 3",
  "name": {
    "familyName": "sample string 1",
    "givenName": "sample string 2"
  },
  "emails": [
    {
      "value": "sample string 1"
    },
    {
      "value": "sample string 1"
    }
  ],
  "phoneNumbers": [
    {
      "value": "sample string 1"
    },
    {
      "value": "sample string 1"
    }
  ],
  "active": true,
  "password": "sample string 5",
  "groups": [
    {
      "value": "sample string 1"
    },
    {
      "value": "sample string 1"
    }
  ],
  "meta": {
    "resourceType": "sample string 1",
    "created": "2024-07-27T01:07:19.1994898-07:00",
    "lastModified": "2024-07-27T01:07:19.1994898-07:00",
    "location": "sample string 4"
  }
}

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.