Patch user - SCIM - Datadog API

PATCHhttps://api.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.us3.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.us5.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.datadoghq.eu/api/v2/scim/Users/{user_uuid}https://api.ap1.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.ap2.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.uk1.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.ddog-gov.com/api/v2/scim/Users/{user_uuid}https://api.us2.ddog-gov.com/api/v2/scim/Users/{user_uuid}

Overview

Patch the user with the given user_uuid. To update Datadog roles, send an operation with path set to roles and value set to an array of role objects containing role UUIDs.

This endpoint requires all of the following permissions:

user_access_invite
user_access_manage

Arguments

Path Parameters

Name

Type

Description

user_uuid [required]

string

None

Request

Body Data (required)

Field

Type

Description

Operations

[object]

A list of update operations to be performed on a user.

schemas

[string]

Input JSON Schemas

{
  "Operations": [
    {
      "op": "string",
      "path": "roles",
      "value": [
        "00000000-0000-0000-0000-000000000001"
      ]
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}

Response

Definition of a user.

Field

Type

Description

active

boolean

A Boolean value indicating the User's administrative status.

emails

[object]

Email addresses for the user.

id

string

The identifier of the resource. Not required when creating a user.

meta

object

Metadata associated with a user.

name

object

The components of user's real name

roles

[object]

Datadog roles assigned to the user. Provide the role UUID in value when provisioning or updating roles through SCIM.

schemas

[string]

User JSON Schemas.

title

string

The user's title.

userName

string

Unique identifier for the User.

{
  "active": false,
  "emails": [
    {
      "primary": false,
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "meta": {
    "created": "2024-10-17 12:53:35.793883+00:00",
    "lastModified": "2024-10-19 12:53:35.793883+00:00",
    "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c",
    "resourceType": "User"
  },
  "name": {
    "formatted": "string"
  },
  "roles": [
    {
      "display": "Datadog Read Only Role",
      "value": "00000000-0000-0000-0000-000000000001"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "title": "string",
  "userName": "string"
}

Bad Request

API error response.

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

Patch user

## default

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## json-request-body

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## default

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## json-request-body

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## default

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## json-request-body

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## default

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## json-request-body

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## default

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## json-request-body

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## default

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## json-request-body

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## default

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## json-request-body

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## default

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## json-request-body

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## default

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

## json-request-body

# Path parameters
export user_uuid="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "path": "roles",
      "value": [
        {
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF