Get SCIM User

Retrieve a specific SCIM User by ID

GET /v1/directory-integration/scim/v2/Users/{id}

Get SCIM User

cURL

curl --request GET \
  --url https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Users/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Users/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Users/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Users/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Users/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Users/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "meta": {
    "created": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z",
    "location": "<string>",
    "resourceType": "<string>",
    "version": "<string>"
  },
  "active": true,
  "addresses": [
    {
      "country": "<string>",
      "display": "<string>",
      "formatted": "<string>",
      "locality": "<string>",
      "postalCode": "<string>",
      "primary": true,
      "region": "<string>",
      "streetAddress": "<string>",
      "type": "<string>"
    }
  ],
  "displayName": "<string>",
  "emails": [
    {
      "display": "<string>",
      "primary": true,
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "entitlements": [
    {
      "display": "<string>",
      "primary": true,
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "externalId": "<string>",
  "groups": [
    {
      "display": "<string>",
      "ref": "<string>",
      "value": "<string>"
    }
  ],
  "id": "<string>",
  "ims": [
    {
      "display": "<string>",
      "primary": true,
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "locale": "<string>",
  "name": {
    "familyName": "<string>",
    "formatted": "<string>",
    "givenName": "<string>",
    "honorificPrefix": "<string>",
    "honorificSuffix": "<string>",
    "middleName": "<string>"
  },
  "nickName": "<string>",
  "password": "<string>",
  "phoneNumbers": [
    {
      "display": "<string>",
      "primary": true,
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "photos": [
    {
      "display": "<string>",
      "primary": true,
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "preferredLanguage": "<string>",
  "profileUrl": "<string>",
  "roles": [
    {
      "display": "<string>",
      "primary": true,
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "schemas": [
    "<string>"
  ],
  "timezone": "<string>",
  "title": "<string>",
  "userName": "<string>",
  "userType": "<string>",
  "x509Certificates": [
    {
      "display": "<string>",
      "primary": true,
      "type": "<string>",
      "value": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

a valid bearer token

Path Parameters

id · string · required

User ID

Response

200

application/json

User retrieved successfully

meta · object · required

Show child attributes

active · boolean

addresses · object[]

Show child attributes

displayName · string

emails · object[]

Show child attributes

entitlements · object[]

Show child attributes

externalId · string

groups · object[]

Show child attributes

id · string

Required string length: 1 - 2147483647

ims · object[]

Show child attributes

locale · string

name · object

Show child attributes

nickName · string

password · string

phoneNumbers · object[]

Show child attributes

photos · object[]

Show child attributes

preferredLanguage · string

profileUrl · string

roles · object[]

Show child attributes

schemas · string[]

Required array length: 1 - 2147483647 elements

timezone · string

title · string

userName · string

userType · string

x509Certificates · object[]

Show child attributes