HOhootsuite
SCIM 2.0

Replace User

Updates a Hootsuite user using the SCIM 2.0 protocol. To see the JSON object attributes required by the PUT endpoint, call the /Schemas endpoint. For a complete example request, see the SCIM specification

put/scim/v2/Users/{memberId}

Request

  • Base URL
    https://platform.hootsuite.com
  • URL
    https://platform.hootsuite.com/scim/v2/Users/{memberId}
  • Auth
    OAuth 2
    Authorization code: https://platform.hootsuite.com/oauth2/auth
    Token URL: https://platform.hootsuite.com/oauth2/token

Path parameters

memberIdstring required

The Member ID

Headers

Authorizationstring required

A bearer token string used for authentication

Request body

schemasstring[]

Required SCIM schemas

userNamestring required
displayNamestring required
timezonestring

The user's time zone. If not provided it will default to "America/Vancouver". Valid values are defined at http://php.net/manual/en/timezones.php.

preferredLanguage'en' | 'ja' | 'fr' | 'it' | 'es' | 'de' | 'pt_BR' | 'pl' | 'id' | 'zh_CN' | 'zh_HK' | 'zh_TW' | 'nl' | 'ko' | 'ar' | 'ru' | 'th' | 'tr'

The user's language.

titlestring
activeboolean required

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "joe.smith@hootsuite.com",
  "name": {
    "givenName": "joe.smith",
    "familyName": "joe.smith"
  },
  "emails": [
    {
      "primary": true,
      "value": "joe.smith@hootsuite.com",
      "type": "work"
    }
  ],
  "displayName": "Joe Smith",
  "timezone": "America/Vancouver",
  "preferredLanguage": "en",
  "title": "Manager",
  "groups": [
    {
      "value": "5838356",
      "$ref": "https://platform.hootsuite.com/scim/v2/groups/663806",
      "display": "Group 1"
    }
  ],
  "active": true
}

Response

Success

schemasstring[]

Required SCIM schemas

idstring
userNamestring
displayNamestring
timezonestring

The user's time zone. If not provided it will default to "America/Vancouver". Valid values are defined at http://php.net/manual/en/timezones.php.

preferredLanguage'en' | 'ja' | 'fr' | 'it' | 'es' | 'de' | 'pt_BR' | 'pl' | 'id' | 'zh_CN' | 'zh_HK' | 'zh_TW' | 'nl' | 'ko' | 'ar' | 'ru' | 'th' | 'tr'

The user's language.

titlestring
groupsobject[]
activeboolean

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "3918310",
  "meta": {
    "resourceType": "User",
    "created": "2012-05-07T15:36:18.000Z",
    "lastModified": "2015-04-21T21:25:40.000Z"
  },
  "userName": "joe.smith@hootsuite.com",
  "name": {
    "givenName": "joe.smith",
    "familyName": "joe.smith"
  },
  "emails": [
    {
      "primary": true,
      "value": "joe.smith@hootsuite.com",
      "type": "work"
    }
  ],
  "displayName": "Joe Smith",
  "timezone": "America/Vancouver",
  "preferredLanguage": "en",
  "title": "Manager",
  "active": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.