BanSync
PUThttps://<3P_WEBHOOK_URI>/Users/{Uber User UUID}¶ Description
This endpoint informs 3P about user ban events using the SCIM 2.0 protocol. Whenever a user is banned or unbanned in Uber systems, that update is synced with the 3P via a PUT request to the 3P’s SCIM 2.0 Update User endpoint.
The endpoint must support TLS 1.2.
¶ Webhook Developer UUID
v1-scim-users
¶ Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| schemas | array<string> | The standard SCIM attribute. Includes the standard SCIM User schema (urn:ietf:params:scim:schemas:core:2.0:User) as well as custom Uber extension attributes (urn:ietf:params:scim:schemas:extension:uber:2.0:User). |
Y |
| id | string | A unique identifier for the SCIM resource as defined by the service provider. This will be the Uber user UUID. | Y |
| username | string | The service provider’s unique identifier for the user. This will be the Uber user UUID. | Y |
| urn:ietf:params:scim:schemas:extension:uber:2.0:User | UberScimExtensionAttributes | The SCIM User Extension for Uber-specific attributes. | Y |
¶ UberScimExtensionAttributes
| Name | Type | Description | Required |
|---|---|---|---|
| banned | boolean | Indicates whether the user has been banned in the Uber identity platform. | Y |
| updateTime | datetime | The datetime when the user data was modified within Uber. Use this value to discard events received out of order. | Y |
¶ Sample Request
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:uber:2.0:User"
],
"id": "<uber_user_uuid>",
"username": "<uber_user_uuid>",
"urn:ietf:params:scim:schemas:extension:uber:2.0:User": {
"banned": true,
"updateTime": "2011-05-13T04:42:34Z"
}
}
¶ Sample Response
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:uber:2.0:User"
],
"id": "<uber_user_uuid>",
"username": "<uber_user_uuid>",
"urn:ietf:params:scim:schemas:extension:uber:2.0:User": {
"banned": true,
"updateTime": "2011-05-13T04:42:34Z"
},
"meta": {
"resourceType": "User",
"lastModified": "2011-05-13T04:42:34Z"
}
}
¶ Response Codes
| Code | Description |
|---|---|
| 200 | Successful response. |
| 403 | The client is not authorized to make the request. |
| 404 | The user ID was not found. |
| 500 | Internal server error. |