Models
¶ CreateUserRequest.UserCreateParams
| Name | Type | Description | Required |
|---|---|---|---|
| user_external_id | string | User id of the user in third party company | Y |
| first_name | string | First name of the user | Y |
| last_name | string | Last name of the user | N |
| email_id | string | Email id of the user | N |
| is_email_confirmed | bool | To indicate whether the email id is confirmed | N |
| phone_number | string | A valid phone number, formatted according to the E.164 recommendation | Y |
| locale_preference | string | BCP47 standard language code. | N |
| tenancy | string | Tenancy of the user | N |
| user_traits | array |
List of user traits. User Traits can represent different properties of the user. | N |
| external_signup_info | ExternalSignupInfo | TODO: Add required annotation after confirming with Careem that they have started sending these params for new user signup Additional sign up information. This captures data when the user signed up in the 3P system. | Y |
| organization_id | string | UUID of the third party customer (3PC) organization the user belongs to. Only meaningful when the calling application holds the guests.trips scope. When omitted, the application is authorized on its own rather than scoped to a specific organization. |
N |
¶ UpdateUserRequest.UserUpdateParams
| Name | Type | Description | Required |
|---|---|---|---|
| user | User | User details of the created user | Y |
| fields_to_update | array |
List of fields to be updated Refer to this table for allowed values of UserAttributeMask. |
Y |
¶ UserAttributeMask
| Name | Number | Description |
|---|---|---|
| USER_ATTRIBUTE_MASK_INVALID | 0 | Default attribute mask. |
| USER_ATTRIBUTE_MASK_FIRST_NAME | 1 | Attribute mask for first name. |
| USER_ATTRIBUTE_MASK_LAST_NAME | 2 | Attribute mask for last name. |
| USER_ATTRIBUTE_MASK_PHONE_NUMBER | 3 | Attribute mask for phone number. |
| USER_ATTRIBUTE_MASK_EMAIL_ID | 4 | Attribute mask for mail. |
| USER_ATTRIBUTE_MASK_EMAIL_CONFIRMATION | 5 | Attribute mask for mail confirmation |
| USER_ATTRIBUTE_MASK_LOCALE_PREFERENCE | 6 | Attribute mask for locale preference. |
| USER_ATTRIBUTE_MASK_USER_TRAITS | 7 | Attribute mask for user traits. |
¶ ThirdPartyRequestContext
| Name | Type | Description | Required |
|---|---|---|---|
| trace_id | string | A unique id per request that can be used to trace a 3P request in Uber systems | Y |
| timestamp | string | The timestamp at which the request was sent to Uber | Y |
| session_id | string | An id that can be used to link multiple requests within a logical session | N |
¶ BanInfo
| Name | Type | Description | Required |
|---|---|---|---|
| is_banned | bool | To indicate whether the user is banned | Y |
| banned_at | string | Unix timestamp at which the user is banned | N |
¶ ExternalSignupInfo
TODO: Add required annotation after confirming with Careem that they have started sending these params for new user signup
| Name | Type | Description | Required |
|---|---|---|---|
| location | Point | Coordinates of the signup location | Y |
| signed_up_at | string | Timestamp at which the user signed up in 3p service | Y |
¶ User
| Name | Type | Description | Required |
|---|---|---|---|
| user_id | string | User id of the user | Y |
| first_name | string | First name of the user | N |
| last_name | string | Last name of the user | N |
| email_id | string | Email id of the user | N |
| is_email_confirmed | bool | To indicate whether the email id is confirmed | N |
| phone_number | string | A valid phone number, formatted according to the E.164 recommendation | N |
| locale_preference | string | BCP47 standard language code. | N |
| tenancy | string | Tenancy of the user | Y |
| ban_info | BanInfo | Ban information of the user | N |
| user_traits | array |
List representing the user traits. | N |