{"id":24706,"date":"2025-02-20T03:24:45","date_gmt":"2025-02-20T03:24:45","guid":{"rendered":"https:\/\/www.psoda.com\/help\/?page_id=24706"},"modified":"2025-10-01T21:10:58","modified_gmt":"2025-10-01T21:10:58","slug":"a31350","status":"publish","type":"page","link":"https:\/\/www.psoda.com\/help\/a31350\/","title":{"rendered":"SCIM 2.0"},"content":{"rendered":"<div class='content-column three_fourth'><h3>SCIM 2.0 API<\/h3>\r\n\r\n<p>The SCIM 2.0 API allows for automated user and group management inside Psoda.<\/p>\r\n\r\n<h3>Headers<\/h3>\r\n<p>All requests must include an <code>API-Key<\/code> in the header. You can find your API key by logging into your account, going to your &#8220;My Stuff&#8221; page, clicking the three dot menu, and clicking the &#8220;API Key&#8221; button. The API key can be passed in two ways:<\/p>\r\n\r\n<p>As a custom <code>API-Key<\/code> header:<\/p>\r\n<pre><code>API-Key: your-api-key-here<\/code><\/pre>\r\n<p>As a Bearer token in the <code>Authorization<\/code> header:<\/p>\r\n<pre><code>Authorization: Bearer your-api-key-here<\/code><\/pre>\r\n\r\n<p>Additionally, include the following <code>Content-Type<\/code> header in your requests:<\/p>\r\n<pre><code>Content-Type: application\/scim+json<\/code><\/pre>\r\n\r\n<h3>Note:<\/h3>\r\n<p>The current implementation does not support PATCH operations or filtering. Updates must be performed using a full object replacement.<\/p>\r\n\r\n<p>Azure integration is still being worked on and will be available in the near future.<\/p>\r\n\r\n<h3>Endpoints<\/h3>\r\n\r\n<h3>1. Get User Details &#8211; <code>GET \/scim\/v2\/Users\/{objectId}<\/code><\/h3>\r\n<p>Returns details of a specific user.<\/p>\r\n\r\n<h3>2. List All Users &#8211; <code>GET \/scim\/v2\/Users<\/code><\/h3>\r\n<p>Gets a paginated list of all users in the system.<\/p>\r\n<p><strong>Query Parameters:<\/strong><\/p>\r\n<ul>\r\n  <li><code>startIndex<\/code> (integer, optional) &#8211; The index of the first result to return.<\/li>\r\n  <li><code>pageSize<\/code> (integer, optional) &#8211; The maximum number of results to return.<\/li>\r\n<\/ul>\r\n\r\n<h3>3. Create a User &#8211; <code>POST \/scim\/v2\/Users<\/code><\/h3>\r\n<p>Creates a new user with the specified attributes. Field information can be found via the schema request.<\/p>\r\n\r\n<h3>4. Update a User &#8211; <code>PUT \/scim\/v2\/Users\/{objectId}<\/code><\/h3>\r\n<p>Updates a user by replacing the full object. Field information can be found via the schema request.<\/p>\r\n\r\n<h3>5. Delete a User &#8211; <code>DELETE \/scim\/v2\/Users\/{objectId}<\/code><\/h3>\r\n<p>Deletes a user. In Psoda, this means suspending the user&#8217;s account.<\/p>\r\n\r\n<h3>6. Get Group Details &#8211; <code>GET \/scim\/v2\/Groups\/{objectId}<\/code><\/h3>\r\n<p>Returns details of a specific group.<\/p>\r\n\r\n<h3>7. List All Groups &#8211; <code>GET \/scim\/v2\/Groups<\/code><\/h3>\r\n<p>Gets a paginated list of all groups.<\/p>\r\n<p><strong>Query Parameters:<\/strong><\/p>\r\n<ul>\r\n  <li><code>startIndex<\/code> (integer, optional) &#8211; The index of the first result to return.<\/li>\r\n  <li><code>pageSize<\/code> (integer, optional) &#8211; The maximum number of results to return.<\/li>\r\n<\/ul>\r\n\r\n<h3>8. Create a Group &#8211; <code>POST \/scim\/v2\/Groups<\/code><\/h3>\r\n<p>Creates a new group with specified members. Field information can be found via the schema request.<\/p>\r\n\r\n<h3>9. Update a Group &#8211; <code>PUT \/scim\/v2\/Groups\/{objectId}<\/code><\/h3>\r\n<p>Updates a group by replacing the full object. Field information can be found via the schema request.<\/p>\r\n\r\n<h3>10. Delete a Group &#8211; <code>DELETE \/scim\/v2\/Groups\/{objectId}<\/code><\/h3>\r\n<p>Deletes a group from the Psoda.<\/p>\r\n\r\n<h3>11. Get Schema Details &#8211; <code>GET \/scim\/v2\/Schemas\/{schemaId}<\/code><\/h3>\r\n<p>Returns details of a specific SCIM schema.<\/p>\r\n\r\n<h3>12. List All Schemas &#8211; <code>GET \/scim\/v2\/Schemas<\/code><\/h3>\r\n<p>Gets a list of all available SCIM schemas in the system.<\/p><\/div>\r\n\r\n<div class='content-column one_fourth last_column'><h4>Related Topics<\/h4>\r\n<ul>\r\n  <li><a href=\"\/help\/a5131\">SAML with Entra ID<\/a><\/li>\r\n  <li><a href=\"\/help\/a89101\">SCIM with Entra ID<\/a><\/li>\r\n<\/ul><\/div><div class='clear_column'><\/div>\r\n","protected":false},"excerpt":{"rendered":"<p><div class='content-column three_fourth'><\/div>    SCIM 2.0 API    The SCIM 2.0 API allows for automated user and group management inside Psoda.    Headers  All requests must include an API-Key in the header. You can find your API key by logging into your account, going to your &#8220;My Stuff&#8221; page, clicking<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"inline_featured_image":false,"footnotes":""},"class_list":["post-24706","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.0 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>SCIM 2.0 - Psoda Help Centre<\/title>\n<meta name=\"description\" content=\"Read the documentation and learn how to use Psoda&#039;s SCIM 2.0\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.psoda.com\/help\/a31350\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"SCIM 2.0 - Psoda Help Centre\" \/>\n<meta property=\"og:description\" content=\"Read the documentation and learn how to use Psoda&#039;s SCIM 2.0\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.psoda.com\/help\/a31350\/\" \/>\n<meta property=\"og:site_name\" content=\"Psoda Help Centre\" \/>\n<meta property=\"article:modified_time\" content=\"2025-10-01T21:10:58+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.psoda.com\/help\/a31350\/\",\"url\":\"https:\/\/www.psoda.com\/help\/a31350\/\",\"name\":\"SCIM 2.0 - Psoda Help Centre\",\"isPartOf\":{\"@id\":\"https:\/\/www.psoda.com\/help\/#website\"},\"datePublished\":\"2025-02-20T03:24:45+00:00\",\"dateModified\":\"2025-10-01T21:10:58+00:00\",\"description\":\"Read the documentation and learn how to use Psoda's SCIM 2.0\",\"breadcrumb\":{\"@id\":\"https:\/\/www.psoda.com\/help\/a31350\/#breadcrumb\"},\"inLanguage\":\"en-NZ\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.psoda.com\/help\/a31350\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.psoda.com\/help\/a31350\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.psoda.com\/help\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"SCIM 2.0\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.psoda.com\/help\/#website\",\"url\":\"https:\/\/www.psoda.com\/help\/\",\"name\":\"Psoda Help Centre\",\"description\":\"Information and support to help you use Psoda\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.psoda.com\/help\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-NZ\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"SCIM 2.0 - Psoda Help Centre","description":"Read the documentation and learn how to use Psoda's SCIM 2.0","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.psoda.com\/help\/a31350\/","og_locale":"en_US","og_type":"article","og_title":"SCIM 2.0 - Psoda Help Centre","og_description":"Read the documentation and learn how to use Psoda's SCIM 2.0","og_url":"https:\/\/www.psoda.com\/help\/a31350\/","og_site_name":"Psoda Help Centre","article_modified_time":"2025-10-01T21:10:58+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.psoda.com\/help\/a31350\/","url":"https:\/\/www.psoda.com\/help\/a31350\/","name":"SCIM 2.0 - Psoda Help Centre","isPartOf":{"@id":"https:\/\/www.psoda.com\/help\/#website"},"datePublished":"2025-02-20T03:24:45+00:00","dateModified":"2025-10-01T21:10:58+00:00","description":"Read the documentation and learn how to use Psoda's SCIM 2.0","breadcrumb":{"@id":"https:\/\/www.psoda.com\/help\/a31350\/#breadcrumb"},"inLanguage":"en-NZ","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.psoda.com\/help\/a31350\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.psoda.com\/help\/a31350\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.psoda.com\/help\/"},{"@type":"ListItem","position":2,"name":"SCIM 2.0"}]},{"@type":"WebSite","@id":"https:\/\/www.psoda.com\/help\/#website","url":"https:\/\/www.psoda.com\/help\/","name":"Psoda Help Centre","description":"Information and support to help you use Psoda","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.psoda.com\/help\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-NZ"}]}},"_links":{"self":[{"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/pages\/24706","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/comments?post=24706"}],"version-history":[{"count":24,"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/pages\/24706\/revisions"}],"predecessor-version":[{"id":24853,"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/pages\/24706\/revisions\/24853"}],"wp:attachment":[{"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/media?parent=24706"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}