List SCIM schemas
curl --request GET \
--url https://api.attio.com/scim/v2/Schemas \
--header 'Authorization: <authorization>'import requests
url = "https://api.attio.com/scim/v2/Schemas"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.attio.com/scim/v2/Schemas', 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://api.attio.com/scim/v2/Schemas",
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: <authorization>"
],
]);
$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://api.attio.com/scim/v2/Schemas"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.attio.com/scim/v2/Schemas")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.attio.com/scim/v2/Schemas")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 2,
"startIndex": 1,
"itemsPerPage": 2,
"Resources": [
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
"id": "urn:ietf:params:scim:schemas:core:2.0:User",
"name": "User",
"description": "Attio workspace member",
"attributes": [
{
"name": "userName",
"type": "string",
"multiValued": false,
"description": "Primary email of the user",
"required": true,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "server"
},
{
"name": "name",
"type": "complex",
"multiValued": false,
"description": "The user's name",
"required": false,
"mutability": "readWrite",
"returned": "default",
"subAttributes": [
{
"name": "givenName",
"type": "string",
"multiValued": false,
"description": "The user's first name",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "familyName",
"type": "string",
"multiValued": false,
"description": "The user's last name",
"required": false,
"mutability": "readWrite",
"returned": "default"
}
]
},
{
"name": "emails",
"type": "complex",
"multiValued": true,
"description": "Email addresses for the user",
"required": false,
"mutability": "readOnly",
"returned": "default",
"subAttributes": [
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "The email address",
"required": false,
"mutability": "readOnly",
"returned": "default"
},
{
"name": "primary",
"type": "boolean",
"multiValued": false,
"description": "Whether this is the primary email address",
"required": false,
"mutability": "readOnly",
"returned": "default"
},
{
"name": "type",
"type": "string",
"multiValued": false,
"description": "The type of email address",
"required": false,
"mutability": "readOnly",
"returned": "default"
}
]
},
{
"name": "active",
"type": "boolean",
"multiValued": false,
"description": "A Boolean value indicating the User's access to a workspace",
"required": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "appRole",
"type": "string",
"multiValued": false,
"description": "The user's access level within the workspace. Can be set to 'admin' or 'member'.",
"required": false,
"canonicalValues": ["admin", "member"],
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
}
],
"meta": {
"resourceType": "Schema",
"location": "/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"
}
},
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
"id": "urn:ietf:params:scim:schemas:core:2.0:Group",
"name": "Group",
"description": "Attio's team",
"attributes": [
{
"name": "displayName",
"type": "string",
"multiValued": false,
"description": "A human-readable name for the team",
"required": true,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "members",
"type": "complex",
"multiValued": true,
"description": "Members of the group",
"required": false,
"mutability": "readWrite",
"returned": "default",
"subAttributes": [
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "Workspace membership ID or workspace invite ID",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "$ref",
"type": "reference",
"multiValued": false,
"description": "URI reference for the member",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "type",
"type": "string",
"multiValued": false,
"description": "The type of the member resource",
"required": false,
"mutability": "readWrite",
"returned": "default"
}
]
}
],
"meta": {
"resourceType": "Schema",
"location": "/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
}
}
]
}
SCIM 2.0
List SCIM schemas
Returns the SCIM 2.0 resource schemas supported by Attio (User and Group), allowing SCIM clients to discover supported attributes.
Required scopes: user_management:read.
GET
/
scim
/
v2
/
Schemas
List SCIM schemas
curl --request GET \
--url https://api.attio.com/scim/v2/Schemas \
--header 'Authorization: <authorization>'import requests
url = "https://api.attio.com/scim/v2/Schemas"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.attio.com/scim/v2/Schemas', 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://api.attio.com/scim/v2/Schemas",
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: <authorization>"
],
]);
$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://api.attio.com/scim/v2/Schemas"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.attio.com/scim/v2/Schemas")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.attio.com/scim/v2/Schemas")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 2,
"startIndex": 1,
"itemsPerPage": 2,
"Resources": [
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
"id": "urn:ietf:params:scim:schemas:core:2.0:User",
"name": "User",
"description": "Attio workspace member",
"attributes": [
{
"name": "userName",
"type": "string",
"multiValued": false,
"description": "Primary email of the user",
"required": true,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "server"
},
{
"name": "name",
"type": "complex",
"multiValued": false,
"description": "The user's name",
"required": false,
"mutability": "readWrite",
"returned": "default",
"subAttributes": [
{
"name": "givenName",
"type": "string",
"multiValued": false,
"description": "The user's first name",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "familyName",
"type": "string",
"multiValued": false,
"description": "The user's last name",
"required": false,
"mutability": "readWrite",
"returned": "default"
}
]
},
{
"name": "emails",
"type": "complex",
"multiValued": true,
"description": "Email addresses for the user",
"required": false,
"mutability": "readOnly",
"returned": "default",
"subAttributes": [
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "The email address",
"required": false,
"mutability": "readOnly",
"returned": "default"
},
{
"name": "primary",
"type": "boolean",
"multiValued": false,
"description": "Whether this is the primary email address",
"required": false,
"mutability": "readOnly",
"returned": "default"
},
{
"name": "type",
"type": "string",
"multiValued": false,
"description": "The type of email address",
"required": false,
"mutability": "readOnly",
"returned": "default"
}
]
},
{
"name": "active",
"type": "boolean",
"multiValued": false,
"description": "A Boolean value indicating the User's access to a workspace",
"required": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "appRole",
"type": "string",
"multiValued": false,
"description": "The user's access level within the workspace. Can be set to 'admin' or 'member'.",
"required": false,
"canonicalValues": ["admin", "member"],
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
}
],
"meta": {
"resourceType": "Schema",
"location": "/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"
}
},
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
"id": "urn:ietf:params:scim:schemas:core:2.0:Group",
"name": "Group",
"description": "Attio's team",
"attributes": [
{
"name": "displayName",
"type": "string",
"multiValued": false,
"description": "A human-readable name for the team",
"required": true,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "members",
"type": "complex",
"multiValued": true,
"description": "Members of the group",
"required": false,
"mutability": "readWrite",
"returned": "default",
"subAttributes": [
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "Workspace membership ID or workspace invite ID",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "$ref",
"type": "reference",
"multiValued": false,
"description": "URI reference for the member",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "type",
"type": "string",
"multiValued": false,
"description": "The type of the member resource",
"required": false,
"mutability": "readWrite",
"returned": "default"
}
]
}
],
"meta": {
"resourceType": "Schema",
"location": "/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
}
}
]
}
Authorizations
This API uses OAuth 2.0 with the authorization code grant flow.
Response
Always
["urn:ietf:params:scim:api:messages:2.0:ListResponse"].Total number of schemas returned.
Always
1.Number of schemas in this response.
The supported schemas. Each entry describes a resource type (
User or Group) and its attributes.{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 2,
"startIndex": 1,
"itemsPerPage": 2,
"Resources": [
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
"id": "urn:ietf:params:scim:schemas:core:2.0:User",
"name": "User",
"description": "Attio workspace member",
"attributes": [
{
"name": "userName",
"type": "string",
"multiValued": false,
"description": "Primary email of the user",
"required": true,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "server"
},
{
"name": "name",
"type": "complex",
"multiValued": false,
"description": "The user's name",
"required": false,
"mutability": "readWrite",
"returned": "default",
"subAttributes": [
{
"name": "givenName",
"type": "string",
"multiValued": false,
"description": "The user's first name",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "familyName",
"type": "string",
"multiValued": false,
"description": "The user's last name",
"required": false,
"mutability": "readWrite",
"returned": "default"
}
]
},
{
"name": "emails",
"type": "complex",
"multiValued": true,
"description": "Email addresses for the user",
"required": false,
"mutability": "readOnly",
"returned": "default",
"subAttributes": [
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "The email address",
"required": false,
"mutability": "readOnly",
"returned": "default"
},
{
"name": "primary",
"type": "boolean",
"multiValued": false,
"description": "Whether this is the primary email address",
"required": false,
"mutability": "readOnly",
"returned": "default"
},
{
"name": "type",
"type": "string",
"multiValued": false,
"description": "The type of email address",
"required": false,
"mutability": "readOnly",
"returned": "default"
}
]
},
{
"name": "active",
"type": "boolean",
"multiValued": false,
"description": "A Boolean value indicating the User's access to a workspace",
"required": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "appRole",
"type": "string",
"multiValued": false,
"description": "The user's access level within the workspace. Can be set to 'admin' or 'member'.",
"required": false,
"canonicalValues": ["admin", "member"],
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
}
],
"meta": {
"resourceType": "Schema",
"location": "/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"
}
},
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
"id": "urn:ietf:params:scim:schemas:core:2.0:Group",
"name": "Group",
"description": "Attio's team",
"attributes": [
{
"name": "displayName",
"type": "string",
"multiValued": false,
"description": "A human-readable name for the team",
"required": true,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "members",
"type": "complex",
"multiValued": true,
"description": "Members of the group",
"required": false,
"mutability": "readWrite",
"returned": "default",
"subAttributes": [
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "Workspace membership ID or workspace invite ID",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "$ref",
"type": "reference",
"multiValued": false,
"description": "URI reference for the member",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "type",
"type": "string",
"multiValued": false,
"description": "The type of the member resource",
"required": false,
"mutability": "readWrite",
"returned": "default"
}
]
}
],
"meta": {
"resourceType": "Schema",
"location": "/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
}
}
]
}
Was this page helpful?
⌘I