v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
Scim
User

Update SCIM User

Updates user. Used by SCIM clients like Okta to provision users.

put/scim/Users/{id}

Path parameters

idstring required

Request body

idstring
schemasstring[]
userNamestring
activeboolean
passwordstring

Example request

{
  "id": "d0dd58e43ded4293a61a8760fcba0458",
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:scim:schemas:extension:okta:1.0"
  ],
  "userName": "steph.c@example.com",
  "externalId": "00ustvXq1A8UAuobW0f5",
  "meta": {
    "created": "04-17-2020 00:00:00",
    "lastModified": "04-17-2020 00:00:00",
    "version": "v1.0"
  },
  "displayName": " Steph Curry",
  "preferredLanguage": "en",
  "locale": "en-US",
  "timezone": "America/Los_Angeles",
  "active": true,
  "emails": [
    {
      "value": "steph.c@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "phoneNumbers": [
    {
      "value": "123-444-5555",
      "type": "mobile"
    }
  ],
  "groups": [
    {
      "display": "Team A",
      "value": "2ccf9bde-68e3-4de4-bc4e-51b927336665"
    },
    {
      "display": "Team B",
      "value": "fe515723-fe2e-4959-a5fa-c4d3937fe7e4"
    }
  ],
  "name": {
    "familyName": "Curry",
    "givenName": "Steph"
  },
  "urn:okta:onprem_app:1.0:user:custom": {
    "roleUUID": "84e67f54-5157-442b-a2b3-8b9c728b2fef"
  }
}

Response

User updated successfully

idstring required
externalIdstring required
schemasstring[] required
userNamestring required
displayNamestring
preferredLanguagestring
localestring
timezonestring
activeboolean required

Example response

{
  "id": "d0dd58e43ded4293a61a8760fcba0458",
  "externalId": "00ustvXq1A8UAuobW0f5",
  "meta": {
    "created": "04-17-2020 00:00:00",
    "lastModified": "04-17-2020 00:00:00",
    "version": "v1.0"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:scim:schemas:extension:okta:1.0"
  ],
  "userName": "steph.c@example.com",
  "displayName": " Steph Curry",
  "preferredLanguage": "en",
  "locale": "en-US",
  "timezone": "America/Los_Angeles",
  "active": true,
  "emails": [
    {
      "value": "steph.c@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "phoneNumbers": [
    {
      "value": "123-444-5555",
      "type": "mobile"
    }
  ],
  "groups": [],
  "name": {
    "familyName": "Curry",
    "givenName": "Steph"
  },
  "urn:okta:onprem_app:1.0:user:custom": {
    "roleUUID": "84e67f54-5157-442b-a2b3-8b9c728b2fef"
  }
}