{"items":[{"type":"link","label":"ReachFive SCIM API","link":"/catalog/api-showdown/api-hub/admin/openapi","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi","content":{"contentType":"overview","meta":{"name":"ReachFive SCIM API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/catalog/api-showdown/api-hub/Admin/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/catalog/api-showdown/api-hub/Admin/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.reachfive.com/contact-us","url":"https://www.reachfive.com/contact-us"},{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"documentation@reachfive.com","label":"documentation@reachfive.com","withCopyButton":true,"copyContent":"documentation@reachfive.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://www.reachfive.com/terms-policies"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"ReachFive SCIM API (latest)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{"className":"fa fa-gear fa-spin fa-2x","style":{"color":"#00c24a"}}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BETA RELEASE"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A beta release is the first offering of the feature and may not be fully available to all customers. Contact your ReachFive representative for more details."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SCIM protocol is an application-level REST protocol for provisioning and managing identity data on the web."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It supports creating, discovering, retrieving, and modifying core identity resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For more on SCIM, please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc7644"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/catalog/api-showdown/api-hub/admin/openapi"},{"nodeType":"external-docs","url":"../home/index.html","description":"For more ReachFive documentation."}],"sectionId":"/catalog/api-showdown/api-hub/admin/openapi"}]}]}},{"type":"group","label":"Authentication","link":"/catalog/api-showdown/api-hub/admin/openapi/authentication","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/authentication","items":[],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All SCIM endpoints require a token authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You'll need to start the SCIM configuration from the ReachFive Console to obtain an API Key to use as bearer token."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.reachfive.com/docs/scim.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM on the console"},"children":[]}]}]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication"}],"panels":[]}]}},{"type":"group","label":"Service Provider Configuration","link":"/catalog/api-showdown/api-hub/admin/openapi/serviceproviderconfig","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/serviceproviderconfig","items":[{"label":"Retrieve service provider config","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/serviceproviderconfig/getserviceprovicerconfig","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/serviceproviderconfig/getserviceprovicerconfig","metadata":{"seo":{"title":"Retrieve service provider config","description":"This operation returns a JSON structure that describes the SCIM specification features available on a service provider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getServiceProvicerConfig","name":"Retrieve service provider config","isWebhook":false,"pointer":"/paths/~1scim~1v2~1ServiceProviderConfig/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve service provider config","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation returns a JSON structure that describes the SCIM specification features available on a service provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response is a JSON object using a \"schemas\" attribute of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The attributes returned in the JSON object are defined in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643#section-5"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 5 of [RFC7643]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/ServiceProviderConfig","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/scim/v2/ServiceProviderConfig","href":"serviceproviderconfig/getserviceprovicerconfig","openApiOperationId":"getServiceProvicerConfig","summary":"Retrieve service provider config"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful GET operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serviceProviderConfigResponse"}},"schemaId":"components/schemas/serviceProviderConfigResponse"},{"code":"404","description":"No configuration found."}],"pointer":"/paths/~1scim~1v2~1ServiceProviderConfig/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/serviceProviderConfigResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serviceProviderConfigResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/serviceproviderconfig/getserviceprovicerconfig"}],"panels":[]}]},"httpPath":"/scim/v2/ServiceProviderConfig"}],"content":{"contentType":"group","meta":{"name":"ServiceProviderConfig"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Service Provider Configuration","showPageActions":true},{"nodeType":"markdoc","content":"Describes the SCIM specification features available on service provider."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scim/v2/ServiceProviderConfig","summary":"Retrieve service provider config","prefix":{"name":"get","color":"get"},"badges":[],"link":"/serviceproviderconfig/getserviceprovicerconfig","deprecated":false}]}]}]}]}},{"type":"group","label":"Resource Types","link":"/catalog/api-showdown/api-hub/admin/openapi/resourcetypes","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/resourcetypes","items":[{"label":"Retrieve resource types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/resourcetypes/getresourcetype","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/resourcetypes/getresourcetype","metadata":{"seo":{"title":"Retrieve resource types","description":"This operation is used to discover the types of resources available on a SCIM service provider (e.g., Users and Groups).Each resource type defines the endpoints, the core schema URI that defines the resource, and any supported schema extensions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getResourceType","name":"Retrieve resource types","isWebhook":false,"pointer":"/paths/~1scim~1v2~1ResourceTypes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve resource types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is used to discover the types of resources available on a SCIM service provider (e.g., Users and Groups)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each resource type defines the endpoints, the core schema URI that defines the resource, and any supported schema extensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The attributes defining a resource type can be found in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643#section-6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 6 of [RFC7643]"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/ResourceTypes","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/scim/v2/ResourceTypes","href":"resourcetypes/getresourcetype","openApiOperationId":"getResourceType","summary":"Retrieve resource types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful GET operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resourceTypeListResponse"}},"schemaId":"components/schemas/resourceTypeListResponse"},{"code":"404","description":"No configuration found"}],"pointer":"/paths/~1scim~1v2~1ResourceTypes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/resourceTypeListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resourceTypeListResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/resourcetypes/getresourcetype"}],"panels":[]}]},"httpPath":"/scim/v2/ResourceTypes"},{"label":"Retrieve resource type by name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/resourcetypes/getresourcetypename","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/resourcetypes/getresourcetypename","metadata":{"seo":{"title":"Retrieve resource type by name","description":"This operation is used to retireve an individual resource by his name (e.g., User and Group)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getResourceTypeName","name":"Retrieve resource type by name","isWebhook":false,"pointer":"/paths/~1scim~1v2~1ResourceTypes~1{name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve resource type by name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation is used to retireve an individual resource by his name (e.g., User and Group).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_110","description":"The name of the resource type.","required":true,"example":"User"}],"pointer":"/paths/~1scim~1v2~1ResourceTypes~1{name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/ResourceTypes/{name}","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"name","in":"path","required":true,"example":"User","schemaId":"schema_110"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/scim/v2/ResourceTypes/{name}","href":"resourcetypes/getresourcetypename","openApiOperationId":"getResourceTypeName","summary":"Retrieve resource type by name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful GET operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resourceTypeResponse"}},"schemaId":"components/schemas/resourceTypeResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}},"schemaId":"schema_111"}],"pointer":"/paths/~1scim~1v2~1ResourceTypes~1{name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/resourceTypeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resourceTypeResponse"}}},{"code":"404","schemaId":"schema_111","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/resourcetypes/getresourcetypename"}],"panels":[]}]},"httpPath":"/scim/v2/ResourceTypes/{name}"}],"content":{"contentType":"group","meta":{"name":"ResourceTypes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resource Types","showPageActions":true},{"nodeType":"markdoc","content":"Discover the types of resources available on SCIM service provider (e.g., Users and Groups)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scim/v2/ResourceTypes","summary":"Retrieve resource types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/resourcetypes/getresourcetype","deprecated":false},{"title":"/scim/v2/ResourceTypes/{name}","summary":"Retrieve resource type by name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/resourcetypes/getresourcetypename","deprecated":false}]}]}]}]}},{"type":"group","label":"Schemas","link":"/catalog/api-showdown/api-hub/admin/openapi/schemas","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/schemas","items":[{"label":"Retrieve schemas","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/schemas/getschemas","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/schemas/getschemas","metadata":{"seo":{"title":"Retrieve schemas","description":"This operation is used to retrieve information about resource schemas supported by a SCIM service provider. An HTTP GET to the endpoint \"/Schemas\" will return all supported schemas in ListResponse format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSchemas","name":"Retrieve schemas","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Schemas/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve schemas","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is used to retrieve information about resource schemas supported by a SCIM service provider. An HTTP GET to the endpoint \"/Schemas\" will return all supported schemas in ListResponse format."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The contents of each schema returned are described in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643#section-7"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 7 of [RFC7643]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Schemas","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/scim/v2/Schemas","href":"schemas/getschemas","openApiOperationId":"getSchemas","summary":"Retrieve schemas"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful GET operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schemaListResponse"}},"schemaId":"components/schemas/schemaListResponse"},{"code":"404","description":"Not found."}],"pointer":"/paths/~1scim~1v2~1Schemas/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/schemaListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schemaListResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schemas/getschemas"}],"panels":[]}]},"httpPath":"/scim/v2/Schemas"},{"label":"Retrieve specific schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/schemas/getschema","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/schemas/getschema","metadata":{"seo":{"title":"Retrieve specific schema","description":"This operation is used to retrieve individual schema definitions by his schema URI."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSchema","name":"Retrieve specific schema","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Schemas~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve specific schema","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is used to retrieve individual schema definitions by his schema URI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The contents of schema returned are described in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643#section-7"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 7 of [RFC7643]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_110","description":"The specific schema ID.","required":true,"example":"urn:ietf:params:scim:schemas:core:2.0:Group"}],"pointer":"/paths/~1scim~1v2~1Schemas~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Schemas/{id}","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"urn:ietf:params:scim:schemas:core:2.0:Group","schemaId":"schema_110"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/scim/v2/Schemas/{id}","href":"schemas/getschema","openApiOperationId":"getSchema","summary":"Retrieve specific schema"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful GET operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schemaResponse"}},"schemaId":"components/schemas/schemaResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}},"schemaId":"schema_111"}],"pointer":"/paths/~1scim~1v2~1Schemas~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/schemaResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schemaResponse"}}},{"code":"404","schemaId":"schema_111","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schemas/getschema"}],"panels":[]}]},"httpPath":"/scim/v2/Schemas/{id}"}],"content":{"contentType":"group","meta":{"name":"Schemas"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schemas","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve information about resource schemas supported by a SCIM service provider."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scim/v2/Schemas","summary":"Retrieve schemas","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schemas/getschemas","deprecated":false},{"title":"/scim/v2/Schemas/{id}","summary":"Retrieve specific schema","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schemas/getschema","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/catalog/api-showdown/api-hub/admin/openapi/users","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/users","items":[{"label":"Query users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/users/queryuser","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/users/queryuser","metadata":{"seo":{"title":"Query users","description":"The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryUser","name":"Query users","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more on filtering with SCIM routes, please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7644 Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients may request a subset of resources by specifying the \"filter\" query parameter containing a filter expression.When specified, only those resources matching the filter expression will be returned. The expression language that is used with the filter parameter supports references to attributes and literals."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute names and attribute operators used in filters are case insensitive."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more on filtering with SCIM routes, please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7644 Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"userName eq \"john\""},{"name":"attributes","in":"query","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A multi-valued list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. Attribute names must be in standard attribute notation ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.10"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.10"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") form."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.9"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.9"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for additional retrieval query parameters."},"children":[]}]}]}]}],"example":"userName"},{"name":"excludedAttributes","in":"query","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. This parameter will have no effect on attributes whose schema \"returned\" setting is \"always\" (see Sections "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-7"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC7643"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]).  Attribute names must be in standard attribute notation ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.10"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.10"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") form."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.9"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.9"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for additional retrieval query parameters."},"children":[]}]}]}]}],"example":"givenName"},{"name":"sortBy","in":"query","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"sortBy\" parameter specifies the attribute whose value will be used to order the returned responses. If the \"sortBy\" ttribute corresponds to a singular attribute, resources are sorted according to that attribute's value; if it's a multi-valued attribute, resources are sorted by the value of the primary attribute (see Section 2.4 of ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC7643"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]), if any, or else the first value in the list, if any. If the attribute is complex, the attribute name must be a path to a sub-attribute in standard attribute notation ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.10"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.10"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy=name.givenName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all attribute types, if there is no data for the specified \"sortBy\" value, they are sorted via the \"sortOrder\" parameter, i.e., they are ordered last if ascending and first if descending."},"children":[]}]}]}],"example":"name.givenName"},{"name":"sortOrder","in":"query","schemaId":"schema_112","description":"The order in which the \"sortBy\" parameter is applied. Allowed values are \"ascending\" and \"descending\". If a value for \"sortBy\" is provided and no \"sortOrder\" is specified, \"sortOrder\" will default to ascending. String type attributes are case insensitive by default, unless the attribute type is defined as a case-exact string. \"sortOrder\" must sort according to the attribute type; i.e., for case-insensitive attributes, sort the result using case-insensitive Unicode alphabetic sort order with no specific locale implied, and for case-exact attribute types, sort the result using case-sensitive Unicode alphabetic sort order.\n","example":"ascending"},{"name":"startIndex","in":"query","schemaId":"schema_113","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 1-based index of the first query result. Values of less than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are interpreted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.4"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.4.2.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details about Pagination."},"children":[]}]}]}]}],"example":1},{"name":"count","in":"query","schemaId":"schema_113","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the desired maximum number of results per page. Negative values are as interpreted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.4"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.4.2.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details about Pagination."},"children":[]}]}]}]}],"example":10}],"pointer":"/paths/~1scim~1v2~1Users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Users","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","example":"userName eq \"john\"","schemaId":"schema_110"},{"name":"attributes","in":"query","example":"userName","schemaId":"schema_110"},{"name":"excludedAttributes","in":"query","example":"givenName","schemaId":"schema_110"},{"name":"sortBy","in":"query","example":"name.givenName","schemaId":"schema_110"},{"name":"sortOrder","in":"query","example":"ascending","schemaId":"schema_112"},{"name":"startIndex","in":"query","example":1,"schemaId":"schema_113"},{"name":"count","in":"query","example":10,"schemaId":"schema_113"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/scim/v2/Users","href":"users/queryuser","openApiOperationId":"queryUser","summary":"Query users"},"definitionSamples":[{"lang":"cURL","source":"curl --request GET \\\n  --url https://YOUR_DOMAIN/scim/v2/Users \\\n  --header 'Content-type: application/scim+json' \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful query","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/queryUserResponse"}},"schemaId":"components/schemas/queryUserResponse"},{"code":"404","description":"No resource found."}],"pointer":"/paths/~1scim~1v2~1Users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/queryUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/queryUserResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/queryuser"}],"panels":[]}]},"httpPath":"/scim/v2/Users"},{"label":"Create a new user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/users/createuser","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/users/createuser","metadata":{"seo":{"title":"Create a new user","description":"Creates a new user and brings that user object to the service provider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUser","name":"Create a new user","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new user and brings that user object to the service provider.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createUserRequest"}},"schemaId":"components/schemas/createUserRequest","pointer":"/paths/~1scim~1v2~1Users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Users","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createUserRequest"}},"responseCodes":["201","409"],"pointer":"/scim/v2/Users","href":"users/createuser","openApiOperationId":"createUser","summary":"Create a new user"},"definitionSamples":[{"lang":"cURL","source":"curl --request POST \\\n  --url https://YOUR_DOMAIN/scim/v2/Users \\\n  --header 'Content-type: application/scim+json' \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/createUserRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createUserRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createUserResponse"}},"schemaId":"components/schemas/createUserResponse"},{"code":"409","description":"Resource already exists in service provider."}],"pointer":"/paths/~1scim~1v2~1Users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/createUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createUserResponse"}}},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/createuser"}],"panels":[]}]},"httpPath":"/scim/v2/Users"},{"label":"Retrieve a known user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/users/getuser","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/users/getuser","metadata":{"seo":{"title":"Retrieve a known user","description":"Retrieve a known user by their ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Retrieve a known user","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{userId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a known user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a known user by their ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This checks the user is present in the SCIM application."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_114","description":"The user ID.","required":true,"example":"2819c223-7f76-453a-919d-413861904646"}],"pointer":"/paths/~1scim~1v2~1Users~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Users/{userId}","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"2819c223-7f76-453a-919d-413861904646","schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/scim/v2/Users/{userId}","href":"users/getuser","openApiOperationId":"getUser","summary":"Retrieve a known user"},"definitionSamples":[{"lang":"cURL","source":"curl --request GET \\\n  --url https://YOUR_DOMAIN/scim/v2/Users/{userId} \\\n  --header 'Content-type: application/scim+json' \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getUserResponse"}},"schemaId":"components/schemas/getUserResponse"},{"code":"404","description":"Resource not found."}],"pointer":"/paths/~1scim~1v2~1Users~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/getUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getUserResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuser"}],"panels":[]}]},"httpPath":"/scim/v2/Users/{userId}"},{"label":"Modifies a user with a set of client-specified changes (partial update).","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/users/modifyuserattributes","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/users/modifyuserattributes","metadata":{"seo":{"title":"Modifies a user with a set of client-specified changes (partial update).","description":"Update one or more attributes of a SCIM resource using a sequence of operations to \"add\", \"remove\", or \"replace\" values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"modifyUserAttributes","name":"Modifies a user with a set of client-specified changes (partial update).","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{userId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modifies a user with a set of client-specified changes (partial update).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update one or more attributes of a SCIM resource using a sequence of operations to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"add\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"remove\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"replace\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The general form of the SCIM "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request is based on the JSON Patch approach. Find more at ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc6902"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC6902"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One difference between SCIM "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and JSON Patch is that SCIM servers do not support array indexing and do not support ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc6902"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC6902"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] operation types relating to array element manipulation, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"move\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of each request must contain the \"schemas\" attribute with the URI value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"urn:ietf:params:scim:api:messages:2.0:PatchOp\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request must contain the attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Operations\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" whose value is an array of one or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations. Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation object must have exactly one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"op\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" member whose value indicates the operation to perform and may be one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"add\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"remove\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"replace\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The semantics of each operation are defined in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.5.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.5.2 of [RFC7644]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"path\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute value is a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" containing an attribute path describing the target of the operation.  The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"path\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute is "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"add\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"replace\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"remove\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each operation against an attribute must be compatible with the attribute's mutability and schema as defined in Sections "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643#section-2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643#section-2.3"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC7643"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a client "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" modify an attribute that has mutability "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"readOnly\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"immutable\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  However, a client may "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"add\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a value to an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"immutable\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute if the attribute had no previous value.  An operation that is not compatible with an attribute's mutability or schema will return the appropriate HTTP response status code and a JSON detail error response as defined in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.12"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.12"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation represents a single action to be applied to the same SCIM resource specified by the request URI. Operations are applied sequentially in the order they appear in the array.  Each operation in the sequence is applied to the target resource; the resulting resource becomes the target of the next operation. Evaluation continues until all operations are successfully applied or until an error condition is encountered."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For multi-valued attributes, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation that sets a value's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"primary\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sub-attribute to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"true\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will cause the server to automatically set \"primary\" to \"false\" for any other values in the array."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_114","description":"The user ID.","required":true,"example":"2819c223-7f76-453a-919d-413861904646"}],"pointer":"/paths/~1scim~1v2~1Users~1{userId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patchUserRequest"}},"schemaId":"components/schemas/patchUserRequest","pointer":"/paths/~1scim~1v2~1Users~1{userId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/scim/v2/Users/{userId}","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"2819c223-7f76-453a-919d-413861904646","schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patchUserRequest"}},"responseCodes":["200","404"],"pointer":"/scim/v2/Users/{userId}","href":"users/modifyuserattributes","openApiOperationId":"modifyUserAttributes","summary":"Modifies a user with a set of client-specified changes (partial update)."},"definitionSamples":[{"lang":"cURL","source":"curl --request PUT \\\n  --url https://YOUR_DOMAIN/scim/v2/Users/{userId} \\\n  --header 'Content-type: application/scim+json' \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/patchUserRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patchUserRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully patched the user attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createUserResponse"}},"schemaId":"components/schemas/createUserResponse"},{"code":"404","description":"Resource not found."}],"pointer":"/paths/~1scim~1v2~1Users~1{userId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/createUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createUserResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/modifyuserattributes"}],"panels":[]}]},"httpPath":"/scim/v2/Users/{userId}"},{"label":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/users/replaceuserattributes","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/users/replaceuserattributes","metadata":{"seo":{"title":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).","description":"Used to replace a resource's attributes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceUserAttributes","name":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{userId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to replace a resource's attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, clients that have previously retrieved the entire resource in advance and revised it may replace the resource using an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Because SCIM resource identifiers are assigned by the service provider, HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be used to create new resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": As the operation's intent is to replace all attributes, SCIM clients may send all attributes, regardless of each attribute's mutability."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_114","description":"The user ID.","required":true,"example":"2819c223-7f76-453a-919d-413861904646"}],"pointer":"/paths/~1scim~1v2~1Users~1{userId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateUserRequest"}},"schemaId":"components/schemas/updateUserRequest","pointer":"/paths/~1scim~1v2~1Users~1{userId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scim/v2/Users/{userId}","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"2819c223-7f76-453a-919d-413861904646","schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updateUserRequest"}},"responseCodes":["200","404"],"pointer":"/scim/v2/Users/{userId}","href":"users/replaceuserattributes","openApiOperationId":"replaceUserAttributes","summary":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace)."},"definitionSamples":[{"lang":"cURL","source":"curl --request PUT \\\n  --url https://YOUR_DOMAIN/scim/v2/Users/{userId} \\\n  --header 'Content-type: application/scim+json' \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/updateUserRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateUserRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createUserResponse"}},"schemaId":"components/schemas/createUserResponse"},{"code":"404","description":"Resource not found."}],"pointer":"/paths/~1scim~1v2~1Users~1{userId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/createUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createUserResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/replaceuserattributes"}],"panels":[]}]},"httpPath":"/scim/v2/Users/{userId}"},{"label":"Deletes a user.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/users/deleteuser","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/users/deleteuser","metadata":{"seo":{"title":"Deletes a user.","description":"This operations removes the user from the ReachFive side."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUser","name":"Deletes a user.","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{userId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a user.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operations removes the user from the ReachFive side.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_114","description":"The user ID.","required":true,"example":"2819c223-7f76-453a-919d-413861904646"}],"pointer":"/paths/~1scim~1v2~1Users~1{userId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/scim/v2/Users/{userId}","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"2819c223-7f76-453a-919d-413861904646","schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/scim/v2/Users/{userId}","href":"users/deleteuser","openApiOperationId":"deleteUser","summary":"Deletes a user."},"definitionSamples":[{"lang":"cURL","source":"curl --request DELETE \\\n  --url https://YOUR_DOMAIN/scim/v2/Users/{userId} \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully removed the user"},{"code":"404","description":"Resource not found."}],"pointer":"/paths/~1scim~1v2~1Users~1{userId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/deleteuser"}],"panels":[]}]},"httpPath":"/scim/v2/Users/{userId}"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve, add, modify Users."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scim/v2/Users","summary":"Query users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/queryuser","deprecated":false},{"title":"/scim/v2/Users","summary":"Create a new user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/createuser","deprecated":false},{"title":"/scim/v2/Users/{userId}","summary":"Retrieve a known user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuser","deprecated":false},{"title":"/scim/v2/Users/{userId}","summary":"Modifies a user with a set of client-specified changes (partial update).","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/users/modifyuserattributes","deprecated":false},{"title":"/scim/v2/Users/{userId}","summary":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/replaceuserattributes","deprecated":false},{"title":"/scim/v2/Users/{userId}","summary":"Deletes a user.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/deleteuser","deprecated":false}]}]}]}]}},{"type":"group","label":"Groups","link":"/catalog/api-showdown/api-hub/admin/openapi/groups","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/groups","items":[{"label":"Query groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/groups/querygroup","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/groups/querygroup","metadata":{"seo":{"title":"Query groups","description":"The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryGroup","name":"Query groups","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more on filtering with SCIM routes, please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7644 Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients may request a subset of resources by specifying the \"filter\" query parameter containing a filter expression.When specified, only those resources matching the filter expression will be returned. The expression language that is used with the filter parameter supports references to attributes and literals."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute names and attribute operators used in filters are case insensitive."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more on filtering with SCIM routes, please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7644 Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"userName eq \"john\""},{"name":"attributes","in":"query","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A multi-valued list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. Attribute names must be in standard attribute notation ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.10"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.10"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") form."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.9"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.9"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for additional retrieval query parameters."},"children":[]}]}]}]}],"example":"userName"},{"name":"excludedAttributes","in":"query","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. This parameter will have no effect on attributes whose schema \"returned\" setting is \"always\" (see Sections "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-7"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC7643"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]).  Attribute names must be in standard attribute notation ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.10"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.10"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") form."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.9"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.9"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for additional retrieval query parameters."},"children":[]}]}]}]}],"example":"givenName"},{"name":"sortBy","in":"query","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"sortBy\" parameter specifies the attribute whose value will be used to order the returned responses. If the \"sortBy\" ttribute corresponds to a singular attribute, resources are sorted according to that attribute's value; if it's a multi-valued attribute, resources are sorted by the value of the primary attribute (see Section 2.4 of ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC7643"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]), if any, or else the first value in the list, if any. If the attribute is complex, the attribute name must be a path to a sub-attribute in standard attribute notation ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.10"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.10"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy=name.givenName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all attribute types, if there is no data for the specified \"sortBy\" value, they are sorted via the \"sortOrder\" parameter, i.e., they are ordered last if ascending and first if descending."},"children":[]}]}]}],"example":"name.givenName"},{"name":"sortOrder","in":"query","schemaId":"schema_112","description":"The order in which the \"sortBy\" parameter is applied. Allowed values are \"ascending\" and \"descending\". If a value for \"sortBy\" is provided and no \"sortOrder\" is specified, \"sortOrder\" will default to ascending. String type attributes are case insensitive by default, unless the attribute type is defined as a case-exact string. \"sortOrder\" must sort according to the attribute type; i.e., for case-insensitive attributes, sort the result using case-insensitive Unicode alphabetic sort order with no specific locale implied, and for case-exact attribute types, sort the result using case-sensitive Unicode alphabetic sort order.\n","example":"ascending"},{"name":"startIndex","in":"query","schemaId":"schema_113","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 1-based index of the first query result. Values of less than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are interpreted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.4"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.4.2.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details about Pagination."},"children":[]}]}]}]}],"example":1},{"name":"count","in":"query","schemaId":"schema_113","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the desired maximum number of results per page. Negative values are as interpreted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.4"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.4.2.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details about Pagination."},"children":[]}]}]}]}],"example":10}],"pointer":"/paths/~1scim~1v2~1Groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Groups","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","example":"userName eq \"john\"","schemaId":"schema_110"},{"name":"attributes","in":"query","example":"userName","schemaId":"schema_110"},{"name":"excludedAttributes","in":"query","example":"givenName","schemaId":"schema_110"},{"name":"sortBy","in":"query","example":"name.givenName","schemaId":"schema_110"},{"name":"sortOrder","in":"query","example":"ascending","schemaId":"schema_112"},{"name":"startIndex","in":"query","example":1,"schemaId":"schema_113"},{"name":"count","in":"query","example":10,"schemaId":"schema_113"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/scim/v2/Groups","href":"groups/querygroup","openApiOperationId":"queryGroup","summary":"Query groups"},"definitionSamples":[{"lang":"cURL","source":"curl --request GET \\\n  --url https://YOUR_DOMAIN/scim/v2/Groups \\\n  --header 'Content-type: application/scim+json' \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful query","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/queryGroupResponse"}},"schemaId":"components/schemas/queryGroupResponse"},{"code":"404","description":"No resource found."}],"pointer":"/paths/~1scim~1v2~1Groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/queryGroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/queryGroupResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/querygroup"}],"panels":[]}]},"httpPath":"/scim/v2/Groups"},{"label":"Create a new group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/groups/creategroup","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/groups/creategroup","metadata":{"seo":{"title":"Create a new group","description":"Creates a new group and brings that group object to the service provider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGroup","name":"Create a new group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new group and brings that group object to the service provider.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createGroupRequest"}},"schemaId":"components/schemas/createGroupRequest","pointer":"/paths/~1scim~1v2~1Groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Groups","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createGroupRequest"}},"responseCodes":["201","409"],"pointer":"/scim/v2/Groups","href":"groups/creategroup","openApiOperationId":"createGroup","summary":"Create a new group"},"definitionSamples":[{"lang":"cURL","source":"curl --request POST \\\n  --url https://YOUR_DOMAIN/scim/v2/Groups \\\n  --header 'Content-type: application/scim+json' \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/createGroupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createGroupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the new group","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createGroupResponse"}},"schemaId":"components/schemas/createGroupResponse"},{"code":"409","description":"Resource already exists in service provider."}],"pointer":"/paths/~1scim~1v2~1Groups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/createGroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createGroupResponse"}}},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/creategroup"}],"panels":[]}]},"httpPath":"/scim/v2/Groups"},{"label":"Retrieve a known group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/groups/getgroup","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/groups/getgroup","metadata":{"seo":{"title":"Retrieve a known group","description":"Retrieve a known group by their ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroup","name":"Retrieve a known group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a known group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a known group by their ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This checks the group is present in the SCIM application."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupId","in":"path","schemaId":"schema_114","description":"The group ID.","required":true,"example":"2819c223-7f76-453a-919d-413861904646"}],"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Groups/{groupId}","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"groupId","in":"path","required":true,"example":"2819c223-7f76-453a-919d-413861904646","schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/scim/v2/Groups/{groupId}","href":"groups/getgroup","openApiOperationId":"getGroup","summary":"Retrieve a known group"},"definitionSamples":[{"lang":"cURL","source":"curl --request GET \\\n  --url https://YOUR_DOMAIN/scim/v2/Users/{groupId} \\\n  --header 'Content-type: application/scim+json' \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getGroupResponse"}},"schemaId":"components/schemas/getGroupResponse"},{"code":"404","description":"Resource not found."}],"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/getGroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getGroupResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/getgroup"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/{groupId}"},{"label":"Modifies a group with a set of client-specified changes (partial update).","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/groups/modifygroupattributes","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/groups/modifygroupattributes","metadata":{"seo":{"title":"Modifies a group with a set of client-specified changes (partial update).","description":"Update one or more attributes of a SCIM resource using a sequence of operations to \"add\", \"remove\", or \"replace\" values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"modifyGroupAttributes","name":"Modifies a group with a set of client-specified changes (partial update).","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modifies a group with a set of client-specified changes (partial update).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update one or more attributes of a SCIM resource using a sequence of operations to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"add\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"remove\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"replace\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The general form of the SCIM "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request is based on the JSON Patch approach. Find more at ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc6902"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC6902"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One difference between SCIM "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and JSON Patch is that SCIM servers do not support array indexing and do not support ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc6902"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC6902"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] operation types relating to array element manipulation, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"move\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of each request must contain the \"schemas\" attribute with the URI value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"urn:ietf:params:scim:api:messages:2.0:PatchOp\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request must contain the attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Operations\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" whose value is an array of one or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations. Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation object must have exactly one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"op\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" member whose value indicates the operation to perform and may be one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"add\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"remove\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"replace\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The semantics of each operation are defined in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.5.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.5.2 of [RFC7644]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"path\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute value is a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" containing an attribute path describing the target of the operation.  The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"path\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute is "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"add\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"replace\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"remove\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each operation against an attribute must be compatible with the attribute's mutability and schema as defined in Sections "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643#section-2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643#section-2.3"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC7643"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a client "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" modify an attribute that has mutability "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"readOnly\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"immutable\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  However, a client may "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"add\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a value to an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"immutable\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute if the attribute had no previous value.  An operation that is not compatible with an attribute's mutability or schema will return the appropriate HTTP response status code and a JSON detail error response as defined in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.12"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.12"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation represents a single action to be applied to the same SCIM resource specified by the request URI. Operations are applied sequentially in the order they appear in the array.  Each operation in the sequence is applied to the target resource; the resulting resource becomes the target of the next operation. Evaluation continues until all operations are successfully applied or until an error condition is encountered."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For multi-valued attributes, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation that sets a value's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"primary\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sub-attribute to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"true\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will cause the server to automatically set \"primary\" to \"false\" for any other values in the array."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupId","in":"path","schemaId":"schema_114","description":"The group ID.","required":true,"example":"2819c223-7f76-453a-919d-413861904646"}],"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patchGroupRequest"}},"schemaId":"components/schemas/patchGroupRequest","pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/scim/v2/Groups/{groupId}","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"groupId","in":"path","required":true,"example":"2819c223-7f76-453a-919d-413861904646","schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patchGroupRequest"}},"responseCodes":["200","404"],"pointer":"/scim/v2/Groups/{groupId}","href":"groups/modifygroupattributes","openApiOperationId":"modifyGroupAttributes","summary":"Modifies a group with a set of client-specified changes (partial update)."},"definitionSamples":[{"lang":"cURL","source":"curl --request PUT \\\n  --url https://YOUR_DOMAIN/scim/v2/Users/{groupId} \\\n  --header 'Content-type: application/scim+json' \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/patchGroupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patchGroupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully patched the group attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patchGroupResponse"}},"schemaId":"components/schemas/patchGroupResponse"},{"code":"404","description":"Resource not found."}],"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patchGroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patchGroupResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/modifygroupattributes"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/{groupId}"},{"label":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/groups/replacegroupattributes","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/groups/replacegroupattributes","metadata":{"seo":{"title":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).","description":"Used to replace a resource's attributes. For example, clients that have previously retrieved the entire resource in advance and revised it may replace the resource using an HTTP PUT. Because SCIM resource identifiers are assigned by the service provider, HTTP PUT must not be used to create new resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceGroupAttributes","name":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to replace a resource's attributes. For example, clients that have previously retrieved the entire resource in advance and revised it may replace the resource using an HTTP PUT. Because SCIM resource identifiers are assigned by the service provider, HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be used to create new resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": As the operation's intent is to replace all attributes, SCIM clients may send all attributes, regardless of each attribute's mutability."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupId","in":"path","schemaId":"schema_114","description":"The group ID.","required":true,"example":"2819c223-7f76-453a-919d-413861904646"}],"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateGroupRequest"}},"schemaId":"components/schemas/updateGroupRequest","pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scim/v2/Groups/{groupId}","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"groupId","in":"path","required":true,"example":"2819c223-7f76-453a-919d-413861904646","schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updateGroupRequest"}},"responseCodes":["200","404"],"pointer":"/scim/v2/Groups/{groupId}","href":"groups/replacegroupattributes","openApiOperationId":"replaceGroupAttributes","summary":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace)."},"definitionSamples":[{"lang":"cURL","source":"curl --request PUT \\\n  --url https://YOUR_DOMAIN/scim/v2/Users/{groupId} \\\n  --header 'Content-type: application/scim+json' \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/updateGroupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateGroupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getGroupResponse"}},"schemaId":"components/schemas/getGroupResponse"},{"code":"404","description":"Resource not found."}],"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/getGroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getGroupResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/replacegroupattributes"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/{groupId}"},{"label":"Delete a group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/groups/deletegroup","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/groups/deletegroup","metadata":{"seo":{"title":"Delete a group","description":"This operations removes the group from the ReachFive side."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroup","name":"Delete a group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operations removes the group from the ReachFive side.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupId","in":"path","schemaId":"schema_114","description":"The group ID.","required":true,"example":"2819c223-7f76-453a-919d-413861904646"}],"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/scim/v2/Groups/{groupId}","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"groupId","in":"path","required":true,"example":"2819c223-7f76-453a-919d-413861904646","schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/scim/v2/Groups/{groupId}","href":"groups/deletegroup","openApiOperationId":"deleteGroup","summary":"Delete a group"},"definitionSamples":[{"lang":"cURL","source":"curl --request DELETE \\\n  --url https://YOUR_DOMAIN/scim/v2/Users/{groupId} \\\n  --header 'Authorization: Bearer eyJ0eX...ll4Q2NT'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully removed the group"},{"code":"404","description":"Resource not found."}],"pointer":"/paths/~1scim~1v2~1Groups~1{groupId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/deletegroup"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/{groupId}"}],"content":{"contentType":"group","meta":{"name":"Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Groups","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve, add, modify Groups."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scim/v2/Groups","summary":"Query groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/groups/querygroup","deprecated":false},{"title":"/scim/v2/Groups","summary":"Create a new group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/groups/creategroup","deprecated":false},{"title":"/scim/v2/Groups/{groupId}","summary":"Retrieve a known group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/groups/getgroup","deprecated":false},{"title":"/scim/v2/Groups/{groupId}","summary":"Modifies a group with a set of client-specified changes (partial update).","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/groups/modifygroupattributes","deprecated":false},{"title":"/scim/v2/Groups/{groupId}","summary":"Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).","prefix":{"name":"put","color":"put"},"badges":[],"link":"/groups/replacegroupattributes","deprecated":false},{"title":"/scim/v2/Groups/{groupId}","summary":"Delete a group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/groups/deletegroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk operations","link":"/catalog/api-showdown/api-hub/admin/openapi/bulkops","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/bulkops","items":[{"label":"Perform bulk updates.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/catalog/api-showdown/api-hub/admin/openapi/bulkops/bulkrequest","routeSlug":"/catalog/api-showdown/api-hub/admin/openapi/bulkops/bulkrequest","metadata":{"seo":{"title":"Perform bulk updates.","description":"Enables clients to send a potentially large collection of resource operations in a single request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkRequest","name":"Perform bulk updates.","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Perform bulk updates.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables clients to send a potentially large collection of resource operations in a single request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of a bulk operation contains a set of HTTP resource operations using one of the HTTP methods supported by the API, i.e., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"hr","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk requests are identified using the following schema URI: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"urn:ietf:params:scim:api:messages:2.0:BulkRequest\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk responses are identified using the following URI: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"urn:ietf:params:scim:api:messages:2.0:BulkResponse\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk requests and bulk responses share many attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"hr","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If a bulk job is processed successfully, HTTP response code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be returned; otherwise, an appropriate HTTP error code must be returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service provider must continue performing as many changes as possible and disregard partial failures. The client may override this behavior by specifying a value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failOnErrors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failOnErrors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute defines the number of errors that the service provider should accept before failing the remaining operations returning the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To be able to reference a newly created resource, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulkId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute may be specified when creating new resources. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulkId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is defined by the client as a surrogate identifier in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.7.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.7.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulkId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can then be used by the client to map the service provider id with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulkId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the created resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bulkRequest"}},"schemaId":"components/schemas/bulkRequest","pointer":"/paths/~1scim~1v2~1Bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Bulk","servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/bulkRequest"}},"responseCodes":["200","409"],"pointer":"/scim/v2/Bulk","href":"bulkops/bulkrequest","openApiOperationId":"bulkRequest","summary":"Perform bulk updates."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/bulkRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bulkRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully performed operations.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bulkResponse"}},"schemaId":"components/schemas/bulkResponse"},{"code":"409","description":"Can't resolve circular cross-references between resources in a single bulk job."}],"pointer":"/paths/~1scim~1v2~1Bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/bulkResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bulkResponse"}}},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulkops/bulkrequest"}],"panels":[]}]},"httpPath":"/scim/v2/Bulk"}],"content":{"contentType":"group","meta":{"name":"BulkOps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk operations","showPageActions":true},{"nodeType":"markdoc","content":"Bulk updates to one or more resources."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scim/v2/Bulk","summary":"Perform bulk updates.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulkops/bulkrequest","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Schemas":{"id":"components/schemas/Schemas","kind":"json-schema","title":"Schemas","data":{"type":"object","required":["schemas"],"properties":{"schemas":{"type":"array","items":{"type":"string"}}}}},"components/schemas/SchemaExtension":{"id":"components/schemas/SchemaExtension","kind":"json-schema","title":"SchemaExtension","data":{"type":"object","required":["schemas","required"],"properties":{"schema":{"type":"string","description":"The URI of an extended schema.\nThis must be equal to the \"id\" attribute of a \"Schema\" resource.\n"},"required":{"type":"boolean","description":"A Boolean value that specifies whether or not the schema extension is required for the resource type.\nIf true, a resource of this type must include this schema extension and also include any attributes declared as required in this schema extension.\nIf false, a resource of this type may omit this schema extension.\n"}}}},"components/schemas/Meta":{"id":"components/schemas/Meta","kind":"json-schema","title":"Meta","data":{"type":"object","properties":{"resourceType":{"type":"string","description":"The name of the resource type of the resource."},"created":{"type":"string","format":"date-time","description":"The \"DateTime\" that the resource was added to the service provider."},"lastModified":{"type":"string","format":"date-time","description":"The most recent DateTime that the details of this resource were updated at the service provider."},"location":{"type":"string","description":"The URI of the resource being returned."},"version":{"type":"string","description":"The version of the resource being returned."}}}},"components/schemas/ResourceType":{"id":"components/schemas/ResourceType","kind":"json-schema","title":"ResourceType","data":{"allOf":[{"$ref":"#/components/schemas/Schemas"},{"type":"object","required":["name","endpoint","schema"],"properties":{"id":{"type":"string","description":"The resource type's server unique id."},"name":{"type":"string","description":"The resource type name."},"description":{"type":"string","description":"The resource type's human-readable description."},"endpoint":{"type":"string","description":"The resource type's HTTP-addressable endpoint relative to the Base URL of the service provider."},"schema":{"type":"string","description":"The resource type's primary/base schema URI"},"schemaExtensions":{"type":"array","items":{"$ref":"#/components/schemas/SchemaExtension"}}}}]}},"components/schemas/Attribute":{"id":"components/schemas/Attribute","kind":"json-schema","title":"Attribute","data":{"type":"object","properties":{"name":{"description":"The attribute's name."},"type":{"type":"string","enum":["string","boolean","decimal","integer","dateTime","reference","complex"],"description":"The attribute's data type.  Valid values are \"string\", \"boolean\", \"decimal\", \"integer\", \"dateTime\", \"reference\", and \"complex\".\nWhen an attribute is of type \"complex\", there SHOULD be a corresponding schema attribute \"subAttributes\" defined, listing the sub-attributes of the attribute.\n"},"subAttributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"},"description":"When an attribute is of type \"complex\", \"subAttributes\" defines a set of sub-attributes. \"subAttributes\" has the same schema sub-attributes as \"attributes\".\n"},"multiValued":{"type":"boolean","description":"A Boolean value indicating the attribute's plurality."},"description":{"type":"string","description":"The attribute's human-readable description.\nWhen applicable, service providers must specify the description.\n"},"required":{"type":"boolean","description":"A Boolean value that specifies whether or not the attribute is required.\n"},"canonicalValues":{"type":"string","description":"A collection of suggested canonical values that may be used (e.g., \"work\" and \"home\").  In some cases, service providers may choose to ignore unsupported values.\n"},"caseExact":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Boolean value that specifies whether or not a string attribute is case sensitive."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The server will use case sensitivity when evaluating filters.  For attributes that are case exact, the server will preserve case for any value submitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the attribute is case insensitive, the server may alter case for a submitted value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case sensitivity also impacts how attribute values may be compared against filter values (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.4.2.2 of [RFC7644]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"mutability":{"type":"string","enum":["readOnly","readWrite","immutable","writeOnly"],"description":"A single keyword indicating the circumstances under which the value of the attribute can be (re)defined.\n"},"returned":{"type":"string","enum":["always","never","default","request"],"description":"A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request.\n"},"uniqueness":{"type":"string","enum":["none","server","global"],"description":"A single keyword value that specifies how the service provider enforces uniqueness of attribute values.\nA server may reject an invalid value based on uniqueness by returning HTTP response code 400 (Bad Request).\nA client may enforce uniqueness on the client side to a greater degree than the service provider enforces.\nFor example, a client could make a value unique while the server has uniqueness of \"none\".\n"},"referenceTypes":{"type":"string","enum":["User","Group","external","uri"],"description":"A multi-valued array of JSON strings that indicate the SCIM resource types that may be referenced.\n"}}}},"components/schemas/Schema":{"id":"components/schemas/Schema","kind":"json-schema","title":"Schema","data":{"type":"object","required":["id"],"properties":{"id":{"description":"The unique URI of the schema.\nWhen applicable, service providers must specify the URI, e.g., \"urn:ietf:params:scim:schemas:core:2.0:User\".\nUnlike most other schemas, which use some sort of Globally Unique Identifier (GUID) for the \"id\", the schema \"id\" is a URI so that it can be registered and is portable between different service providers and clients.\n"},"name":{"description":"The schema's human-readable name.\nWhen applicable, service providers must specify the name, e.g., \"User\" or \"Group\".\n"},"description":{"description":"The schema's human-readable description.\nWhen applicable, service providers must specify the description.\n"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"},"description":"A complex type that defines service provider attributes and their qualities via the following set of sub-attributes:\n"}}}},"components/schemas/ListResponse":{"id":"components/schemas/ListResponse","kind":"json-schema","title":"ListResponse","data":{"allOf":[{"$ref":"#/components/schemas/Schemas"},{"type":"object","properties":{"totalResults":{"type":"integer","description":"The total number of results returned by the list."},"itemsPerPage":{"type":"integer","description":"The number of resources returned in a list response page."},"startIndex":{"type":"integer","description":"The 1-based index of the first result in the current set of list results."},"resources":{"type":"array","items":{"type":"object"}}}}],"default":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}}},"components/schemas/ServiceProviderConfig":{"id":"components/schemas/ServiceProviderConfig","kind":"json-schema","title":"ServiceProviderConfig","data":{"type":"object","required":["patch","bulk","filter","changePassword","sort","etag","authenticationSchemes"],"properties":{"documentationUri":{"type":"string","description":"An HTTP-addressable URL pointing to the service provider's human-consumable help documentation."},"patch":{"type":"object","required":["supported"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A complex type that specifies PATCH configuration options."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.5.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.5.2 of [RFC7644]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"supported":{"type":"boolean","description":"A Boolean value specifying whether or not the operation is supported."}}},"bulk":{"type":"object","required":["supported","maxOperations","maxPayloadSize"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A complex type that specifies bulk configuration options."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.7"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.7 of [RFC7644]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"supported":{"type":"boolean","description":"A Boolean value specifying whether or not the operation is supported."},"maxOperations":{"type":"integer","description":"An integer value specifying the maximum number of operations."},"maxPayloadSize":{"type":"integer","description":"An integer value specifying the maximum payload size in bytes."}}},"filter":{"type":"object","required":["supported","maxResults"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A complex type that specifies FILTER options."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.4.2.2 of [RFC7644]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"supported":{"type":"boolean","description":"A Boolean value specifying whether or not the operation is supported."},"maxResults":{"type":"integer","description":"An integer value specifying the maximum number of resources returned in a response."}}},"changePassword":{"type":"object","required":["supported"],"description":"A complex type that specifies configuration options related to changing a password.","properties":{"supported":{"type":"boolean","description":"A Boolean value specifying whether or not the operation is supported."}}},"sort":{"type":"object","required":["supported"],"description":"A complex type that specifies Sort configuration options.","properties":{"supported":{"type":"boolean","description":"A Boolean value specifying whether or not sorting is supported."}}},"etag":{"type":"object","required":["supported"],"description":"A complex type that specifies ETag configuration options.","properties":{"supported":{"type":"boolean","description":"A Boolean value specifying whether or not the operation is supported."}}},"authenticationSchemes":{"type":"array","description":"A multi-valued complex type that specifies supported authentication scheme properties.\nTo enable seamless discovery of configurations, the service provider SHOULD, with the appropriate security considerations, make the authenticationSchemes attribute publicly accessible without prior authentication.\n","items":{"type":"object","required":["type","name","description"],"properties":{"type":{"type":"string","description":"The authentication scheme.\nThis specification defines the values \"oauth\", \"oauth2\", \"oauthbearertoken\", \"httpbasic\", and \"httpdigest\".\n"},"name":{"type":"string","description":"The common authentication scheme name, e.g., HTTP Basic."},"description":{"type":"string","description":"A description of the authentication scheme."},"specUri":{"type":"string","description":"An HTTP-addressable URL pointing to the authentication scheme's specification."},"documentationUri":{"type":"string","description":"An HTTP-addressable URL pointing to the authentication scheme's usage documentation."}}}}}}},"components/schemas/serviceProviderConfigResponse":{"id":"components/schemas/serviceProviderConfigResponse","kind":"json-schema","title":"serviceProviderConfigResponse","data":{"allOf":[{"$ref":"#/components/schemas/ServiceProviderConfig"},{"$ref":"#/components/schemas/Meta"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],"documentationUri":"http://example.com/help/scim.html","patch":{"supported":true},"bulk":{"supported":true,"maxOperations":1000,"maxPayloadSize":1048576},"filter":{"supported":true,"maxResults":200},"changePassword":{"supported":true},"sort":{"supported":true},"etag":{"supported":true},"authenticationSchemes":[{"name":"OAuth Bearer Token","description":"Authentication scheme using the OAuth Bearer Token Standard","specUri":"http://www.rfc-editor.org/info/rfc6750","documentationUri":"http://example.com/help/oauth.html","type":"oauthbearertoken","primary":true},{"name":"HTTP Basic","description":"Authentication scheme using the HTTP Basic Standard","specUri":"http://www.rfc-editor.org/info/rfc2617","documentationUri":"http://example.com/help/httpBasic.html","type":"httpbasic"}],"meta":{"location":"https://example.com/v2/ServiceProviderConfig","resourceType":"ServiceProviderConfig","created":"2010-01-23T04:56:22Z","lastModified":"2011-05-13T04:42:34Z"}}}},"components/schemas/CommonAttributes":{"id":"components/schemas/CommonAttributes","kind":"json-schema","title":"CommonAttributes","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for a SCIM resource as defined by the service provider."},"externalId":{"type":"string","description":"A String that is an identifier for the resource as defined by the provisioning client."}}}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"allOf":[{"$ref":"#/components/schemas/Schemas"},{"$ref":"#/components/schemas/CommonAttributes"},{"type":"object","required":["userName"],"properties":{"userName":{"type":"string","description":"A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider."},"name":{"$ref":"#/components/schemas/name"},"displayName":{"type":"string","description":"The name of the user, suitable for display to end-users."},"nickName":{"type":"string","description":"The casual way to address the user in real life, e.g., \"Bob\" or \"Bobby\" instead of \"Robert\"."},"profileUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A URI that is a uniform resource locator (as defined in Section 1.1.3 of [RFC3986]) and that points to a location representing the user's online profile (e.g., a web page).  URIs are canonicalized per Section 6.2 of [RFC3986]."},"children":[]}]}]}]},"title":{"type":"string","description":"The user's title, such as \"Vice President\"."},"userType":{"type":"string","description":"Used to identify the relationship between the organization and the user. Typical values used might be \"Contractor\", \"Employee\", \"Intern\", \"Temp\", \"External\", and \"Unknown\", but any value may be used."},"preferredLanguage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface. The value indicates the set of natural languages that are preferred. The format of the value is the same as the HTTP Accept-Language header field (not including \"Accept-Language:\") and is specified in Section 5.3.5 of [RFC7231]."},"children":[]}]}]}]},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to indicate the User's default location for purposes of localizing such items as currency, date time format, or numerical representations.A valid value is a language tag as defined in [RFC5646]."},"children":[]}]}]}]},"timezone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The User's time zone, in IANA Time Zone database format [RFC6557], also known as the \"Olson\" time zone database format [Olson-TZ] (e.g., \"America/Los_Angeles\")."},"children":[]}]}]}]},"active":{"type":"boolean","description":"A Boolean value indicating the user's administrative status."},"emails":{"type":"array","description":"Email addresses for the User.","items":{"$ref":"#/components/schemas/MultiValuedAttributes"}},"phoneNumbers":{"type":"array","description":"Phone numbers for the user.","items":{"$ref":"#/components/schemas/MultiValuedAttributes"}},"ims":{"type":"array","description":"Instant messaging address for the user.","items":{"$ref":"#/components/schemas/MultiValuedAttributes"}},"photos":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A URI that is a uniform resource locator (as defined in Section 1.1.3 of [RFC3986]) that points to a resource location representing the user's image."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/MultiValuedAttributes"}},"addresses":{"type":"object","description":"A physical mailing address for this user.","properties":{"formatted":{"type":"string","description":"The full mailing address, formatted for display or use with a mailing label.  This attribute may contain newlines."},"streetAddress":{"type":"string","description":"The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute may contain newlines."},"locality":{"type":"string","description":"The city or locality component."},"region":{"type":"string","description":"The state or region component."},"postalCode":{"type":"string","description":"The zip code or postal code component."},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country name component.When specified, the value must be in ISO 3166-1 \"alpha-2\" code format [ISO3166]; e.g., the United States and Sweden are \"US\" and \"SE\", respectively."},"children":[]}]}]}]}}},"groups":{"type":"array","description":"A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated.","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"$ref":{"type":"string","description":"the URI of the corresponding \"Group\" resources to which the user belongs"}}}},"entitlements":{"type":"string","description":"A list of entitlements for the user that represent a thing the user has."},"roles":{"type":"string","description":"A list of roles for the user that collectively represent who the user is, e.g., \"Student\", \"Faculty\".  No vocabulary or syntax is specified, although it is expected that a role value is a String or label representing a collection of entitlements. This value has no canonical types."},"x509Certificates":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of certificates associated with the resource (e.g., a User).Each value contains exactly one DER-encoded X.509 certificate (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc5280#section-4"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 4 of [RFC5280]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), which must be base64 encoded per Section 4 of [RFC4648]."},"children":[]}]}]}]}}}]}},"components/schemas/name":{"id":"components/schemas/name","kind":"json-schema","title":"name","data":{"type":"object","description":"The components of the user's name.","properties":{"formatted":{"type":"string","description":"The full formatted name of the User.","example":"Ms. Barbara Jane Jensen, III"},"familyName":{"type":"string","description":"The family name (surname, last name) of the User.","example":"Jensen"},"givenName":{"type":"string","description":"The first name of the User.","example":"Barbara"},"middleName":{"type":"string","description":"The middle name(s) of the User.","example":"Jane"},"honorificPrefix":{"type":"string","description":"The honorific prefix(es) of the User, or title in most Western languages.","example":"Ms."},"honorificSuffix":{"type":"string","description":"The honorific suffix(es) of the User, or suffix in most Western languages.","example":"III"}}}},"components/schemas/MultiValuedAttributes":{"id":"components/schemas/MultiValuedAttributes","kind":"json-schema","title":"MultiValuedAttributes","data":{"type":"object","properties":{"value":{"type":"string","description":"The value."},"type":{"type":"string","description":"Indicates the email type such as \"work\" or \"personal\"."},"primary":{"type":"boolean","description":"Indicates the preferred value for this attribute","default":false}}}},"components/schemas/Group":{"id":"components/schemas/Group","kind":"json-schema","title":"Group","data":{"allOf":[{"$ref":"#/components/schemas/Schemas"},{"$ref":"#/components/schemas/CommonAttributes"},{"type":"object","required":["displayName"],"properties":{"displayName":{"type":"string","description":"A human-readable name for the Group."},"members":{"type":"array","description":"A list of members of the Group.","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of an \"id\" attribute of a SCIM resource"},"$ref":{"description":"The URI of a SCIM resource such as a \"User\", or a \"Group\""}}}}}}]}},"components/schemas/PatchRequest":{"id":"components/schemas/PatchRequest","kind":"json-schema","title":"PatchRequest","data":{"allOf":[{"$ref":"#/components/schemas/Schemas"},{"type":"object","required":["Operations"],"properties":{"Operations":{"type":"array","description":"An array of one or more PATCH operations.","items":{"type":"object","required":["op"],"properties":{"op":{"type":"string","enum":["add","replace","remove"],"description":"The operation to perform."},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The JSON Patch [RFC6902] describing the target of the operation."},"children":[]}]}]}]},"value":{"oneOf":[{"type":"integer"},{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"},{"type":"object"}],"description":"The value to be added or replaced."}}}}}}]}},"components/schemas/BulkRequest":{"id":"components/schemas/BulkRequest","kind":"json-schema","title":"BulkRequest","data":{"allOf":[{"$ref":"#/components/schemas/Schemas"},{"type":"object","required":["Operations"],"properties":{"failOnErrors":{"type":"boolean","description":"An integer specifying the number of errors that the service provider will accept before the operation is terminated and an error response is returned."},"Operations":{"type":"array","description":"Defines operations within a bulk job. Each operation corresponds to a single HTTP request against a resource endpoint.","items":{"type":"object","required":["method","path"],"properties":{"method":{"type":"string","enum":["POST","PUT","PATCH","DELETE"],"description":"The HTTP method of the current operation."},"bulkId":{"type":"string","description":"The transient identifier of a newly created resource, unique within a bulk request and created by the client. The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request.\nREQUIRED when \"method\" is \"POST\".\n"},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource's relative path to the SCIM service provider's root."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If \"method\" is \"POST\", the value must specify a resource type endpoint, e.g., /Users or /Groups, whereas all other \"method\" values must specify the path to a specific resource, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/Users/2819c223-7f76-453a-919d-413861904646"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"data":{"type":"string","description":"The resource data as it would appear for a single SCIM POST, PUT, or PATCH operation.\nREQUIRED in a request when \"method\" is \"POST\", \"PUT\", or \"PATCH\".\n"}}}}}}]}},"components/schemas/BulkResponse":{"id":"components/schemas/BulkResponse","kind":"json-schema","title":"BulkResponse","data":{"allOf":[{"$ref":"#/components/schemas/Schemas"},{"type":"object","required":["Operations"],"properties":{"failOnErrors":{"type":"boolean","description":"An integer specifying the number of errors that the service provider will accept before the operation is terminated and an error response is returned."},"Operations":{"type":"array","description":"Defines operations within a bulk job. Each operation corresponds to a single HTTP request against a resource endpoint.","items":{"type":"object","required":["method","path"],"properties":{"method":{"type":"string","enum":["POST","PUT","PATCH","DELETE"],"description":"The HTTP method of the current operation."},"bulkId":{"type":"string","description":"The transient identifier of a newly created resource, unique within a bulk request and created by the client. The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request.\nREQUIRED when \"method\" is \"POST\".\n"},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current resource version. Version may be used if the service provider supports entity-tags (ETags) ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7232#section-2.3"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 2.3 of [RFC7232]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and \"method\" is \"PUT\", \"PATCH\", or \"DELETE\"."},"children":[]}]}]}]},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource's relative path to the SCIM service provider's root."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If \"method\" is \"POST\", the value must specify a resource type endpoint, e.g., /Users or /Groups, whereas all other \"method\" values must specify the path to a specific resource, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/Users/2819c223-7f76-453a-919d-413861904646"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"data":{"type":"string","description":"The resource data as it would appear for a single SCIM POST, PUT, or PATCH operation.\nREQUIRED in a request when \"method\" is \"POST\", \"PUT\", or \"PATCH\".\n"},"location":{"type":"string","description":"The resource endpoint URL.\nREQUIRED in a response, except in the event of a POST failure.\n"},"response":{"type":"string","description":"The HTTP response body for the specified request operation.\nWhen indicating a response with an HTTP status other than a 200-series response, the response body must be included.\nFor normal completion, the server may elect to omit the response body.\n"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HTTP response status code for the requested operation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When indicating an error, the \"response\" attribute must contain the detail error response as per "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7644#section-3.12"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section 3.12"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}}}}]}},"components/schemas/resourceTypeListResponse":{"id":"components/schemas/resourceTypeListResponse","kind":"json-schema","title":"resourceTypeListResponse","data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceType"},"example":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"id":"User","name":"User","endpoint":"/Users","description":"User Account","schema":"urn:ietf:params:scim:schemas:core:2.0:User","schemaExtensions":[{"schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","required":true}],"meta":{"location":"https://example.com/v2/ResourceTypes/User","resourceType":"ResourceType"}},{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"id":"Group","name":"Group","endpoint":"/Groups","description":"Group","schema":"urn:ietf:params:scim:schemas:core:2.0:Group","meta":{"location":"https://example.com/v2/ResourceTypes/Group","resourceType":"ResourceType"}}]}},"components/schemas/resourceTypeResponse":{"id":"components/schemas/resourceTypeResponse","kind":"json-schema","title":"resourceTypeResponse","data":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"$ref":"#/components/schemas/Meta"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"id":"User","name":"User","endpoint":"/Users","description":"User","schema":"urn:ietf:params:scim:schemas:core:2.0:User","schemaExtensions":[{"schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","required":true}],"meta":{"location":"https://example.com/v2/ResourceTypes/User","resourceType":"ResourceType"}}}},"components/schemas/schemaListResponse":{"id":"components/schemas/schemaListResponse","kind":"json-schema","title":"schemaListResponse","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"resources":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"$ref":"#/components/schemas/Meta"}]}}}}],"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"totalResults":2,"itemsPerPage":10,"description":1,"resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"id":"User","name":"User","endpoint":"/Users","description":"User","schema":"urn:ietf:params:scim:schemas:core:2.0:User","schemaExtensions":[{"schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","required":true}],"meta":{"location":"https://example.com/v2/ResourceTypes/User","resourceType":"ResourceType"}},{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"id":"Group","name":"Group","endpoint":"/Groups","description":"Group","schema":"urn:ietf:params:scim:schemas:core:2.0:Group","meta":{"location":"https://example.com/v2/ResourceTypes/Group","resourceType":"ResourceType"}}]}}},"components/schemas/schemaResponse":{"id":"components/schemas/schemaResponse","kind":"json-schema","title":"schemaResponse","data":{"allOf":[{"$ref":"#/components/schemas/Schema"},{"$ref":"#/components/schemas/Meta"}],"example":{"id":"urn:ietf:params:scim:schemas:core:2.0:Group","name":"Group","description":"Group","attributes":[{"name":"displayName","type":"string","multiValued":false,"required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"members","type":"complex","multiValued":true,"required":false,"mutability":"readWrite","returned":"default","subAttributes":[{"name":"value","type":"string","multiValued":false,"required":false,"caseExact":false,"mutability":"immutable","returned":"default","uniqueness":"none"},{"name":"$ref","type":"reference","referenceTypes":["User","Group"],"multiValued":false,"required":false,"caseExact":false,"mutability":"immutable","returned":"default","uniqueness":"none"},{"name":"type","type":"string","multiValued":false,"required":false,"caseExact":false,"canonicalValues":["User","Group"],"mutability":"immutable","returned":"default","uniqueness":"none"}]}],"meta":{"resourceType":"Schema","location":"https://example.com/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"}}}},"components/schemas/queryUserResponse":{"id":"components/schemas/queryUserResponse","kind":"json-schema","title":"queryUserResponse","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"resources":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/User"}]}}}}],"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"totalResults":2,"itemsPerPage":10,"description":1,"resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"2819c223-7f76-453a-919d-413861904646","userName":"bjensen"},{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"c75ad752-64ae-4823-840d-ffa80929976c","userName":"jsmith"}]}}},"components/schemas/getUserResponse":{"id":"components/schemas/getUserResponse","kind":"json-schema","title":"getUserResponse","data":{"allOf":[{"$ref":"#/components/schemas/User"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"2819c223-7f76-453a-919d-413861904646","externalId":"bjensen","meta":{"resourceType":"User","created":"2011-08-01T18:29:49.793Z","lastModified":"2011-08-01T18:29:49.793Z","location\"":"https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646"},"name":{"formatted":"Ms. Barbara J Jensen III","familyName":"Jensen","givenName":"Barbara"},"userName":"bjensen","phoneNumbers":{"value":"555-555-8377","type":"work"},"emails":{"value":"bjensen@example.com","type":"work"}}}},"components/schemas/createUserRequest":{"id":"components/schemas/createUserRequest","kind":"json-schema","title":"createUserRequest","data":{"allOf":[{"$ref":"#/components/schemas/User"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"externalId":"bjensen","name":{"formatted":"Ms. Barbara J Jensen III","familyName":"Jensen","givenName":"Barbara"},"userName":"bjensen","emails":{"value":"bjensen@example.com","type":"work","primary":true}}}},"components/schemas/createUserResponse":{"id":"components/schemas/createUserResponse","kind":"json-schema","title":"createUserResponse","data":{"allOf":[{"$ref":"#/components/schemas/User"},{"$ref":"#/components/schemas/Meta"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"2819c223-7f76-453a-919d-413861904646","externalId":"bjensen","name":{"formatted":"Ms. Barbara J Jensen III","familyName":"Jensen","givenName":"Barbara"},"userName":"bjensen","emails":{"value":"bjensen@example.com","type":"work","primary":true},"meta":{"resourceType":"User","created":"2011-08-01T21:32:44.882Z","lastModified":"2011-08-01T21:32:44.882Z","location":"https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646"}}}},"components/schemas/patchUserRequest":{"id":"components/schemas/patchUserRequest","kind":"json-schema","title":"patchUserRequest","data":{"allOf":[{"$ref":"#/components/schemas/PatchRequest"}],"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"name.familyName","value":"Jensen"}]}}},"components/schemas/patchUserResponse":{"id":"components/schemas/patchUserResponse","kind":"json-schema","title":"patchUserResponse","data":{"allOf":[{"$ref":"#/components/schemas/User"},{"$ref":"#/components/schemas/Meta"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"2819c223-7f76-453a-919d-413861904646","externalId":"bjensen","name":{"formatted":"Ms. Barbara J Jensen III","familyName":"Jensen","givenName":"Barbara"},"userName":"bjensen","emails":{"value":"bjensen@example.com","type":"work","primary":true},"meta":{"resourceType":"User","created":"2011-08-01T21:32:44.882Z","lastModified":"2011-08-01T21:32:44.882Z","location":"https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646"}}}},"components/schemas/updateUserRequest":{"id":"components/schemas/updateUserRequest","kind":"json-schema","title":"updateUserRequest","data":{"allOf":[{"$ref":"#/components/schemas/User"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"2819c223-7f76-453a-919d-413861904646","externalId":"bjensen","name":{"formatted":"Ms. Barbara J Jensen III","familyName":"Jensen","givenName":"Barbara"},"userName":"bjensen","emails":{"value":"bjensen@example.com","type":"work","primary":true}}}},"components/schemas/updateUserResponse":{"id":"components/schemas/updateUserResponse","kind":"json-schema","title":"updateUserResponse","data":{"allOf":[{"$ref":"#/components/schemas/User"},{"$ref":"#/components/schemas/Meta"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"2819c223-7f76-453a-919d-413861904646","externalId":"bjensen","name":{"formatted":"Ms. Barbara J Jensen III","familyName":"Jensen","givenName":"Barbara"},"userName":"bjensen","emails":{"value":"bjensen@example.com","type":"work","primary":true},"meta":{"resourceType":"User","created":"2011-08-01T21:32:44.882Z","lastModified":"2011-08-01T21:32:44.882Z","location":"https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646"}}}},"components/schemas/queryGroupResponse":{"id":"components/schemas/queryGroupResponse","kind":"json-schema","title":"queryGroupResponse","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"resources":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Group"}]}}}}],"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"totalResults":2,"itemsPerPage":10,"description":1,"resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"id":"c3a26dd3-27a0-4dec-a2ac-ce211e105f97","displayName":"groupA","members":[{"value":"92b725cd-9465-4e7d-8c16-01f8e146b87a","ref":"https://example.com/v2/Users/92b725cd-9465-4e7d-8c16-01f8e146b87a","type":"User"}],"meta":{"resourceType":"Group","created":"2011-08-01T18:29:49.793Z","lastModified":"2011-08-01T20:31:02.315Z","location":"https://example.com/v2/Groups/ec3a26dd3-27a0-4dec-a2ac-ce211e105f97"}},{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"id":"6c5bb468-14b2-4183-baf2-06d523e03bd3","displayName":"groupB","members":[{"value":"c3a26dd3-27a0-4dec-a2ac-ce211e105f97","ref":"https://example.com/v2/Groups/c3a26dd3-27a0-4dec-a2ac-ce211e105f97","type":"Group"}],"meta":{"resourceType":"Group","created":"2011-08-01T18:29:50.873Z","lastModified":"2011-08-01T18:29:50.873Z","location":"https://example.com/v2/Groups/6c5bb468-14b2-4183-baf2-06d523e03bd3"}}]}}},"components/schemas/createGroupRequest":{"id":"components/schemas/createGroupRequest","kind":"json-schema","title":"createGroupRequest","data":{"allOf":[{"$ref":"#/components/schemas/Group"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"displayName":"Tour Guides","members":[{"value":"92b725cd-9465-4e7d-8c16-01f8e146b87a","type":"User"}]}}},"components/schemas/createGroupResponse":{"id":"components/schemas/createGroupResponse","kind":"json-schema","title":"createGroupResponse","data":{"allOf":[{"$ref":"#/components/schemas/Group"},{"$ref":"#/components/schemas/Meta"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"id":"e9e30dba-f08f-4109-8486-d5c6a331660a","displayName":"Tour Guides","members":[{"value":"92b725cd-9465-4e7d-8c16-01f8e146b87a","ref":"https://example.com/v2/Users/92b725cd-9465-4e7d-8c16-01f8e146b87a","type":"User"}],"meta":{"resourceType":"Group","created":"2011-08-01T18:29:49.793Z","lastModified":"2011-08-01T20:31:02.315Z","location":"https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a"}}}},"components/schemas/getGroupResponse":{"id":"components/schemas/getGroupResponse","kind":"json-schema","title":"getGroupResponse","data":{"allOf":[{"$ref":"#/components/schemas/Group"},{"$ref":"#/components/schemas/Meta"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"id":"2819c223-7f76-453a-919d-413861904646","displayName":"Tour Guides","members":[{"value":"92b725cd-9465-4e7d-8c16-01f8e146b87a","ref":"https://example.com/v2/Users/92b725cd-9465-4e7d-8c16-01f8e146b87a","type":"User"}],"meta":{"resourceType":"Group","created":"2011-08-01T18:29:49.793Z","lastModified":"2011-08-01T20:31:02.315Z","location":"https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a"}}}},"components/schemas/patchGroupRequest":{"id":"components/schemas/patchGroupRequest","kind":"json-schema","title":"patchGroupRequest","data":{"allOf":[{"$ref":"#/components/schemas/PatchRequest"}],"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"members","value":[{"display":"Babs Jensen","ref":"https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646","value":"2819c223-7f76-453a-919d-413861904646"}]}]}}},"components/schemas/patchGroupResponse":{"id":"components/schemas/patchGroupResponse","kind":"json-schema","title":"patchGroupResponse","data":{"allOf":[{"$ref":"#/components/schemas/Group"},{"$ref":"#/components/schemas/Meta"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"id":"2819c223-7f76-453a-919d-413861904646","displayName":"Tour Guides","members":[{"value":"92b725cd-9465-4e7d-8c16-01f8e146b87a","ref":"https://example.com/v2/Users/92b725cd-9465-4e7d-8c16-01f8e146b87a","type":"User"},{"value":"2819c223-7f76-453a-919d-413861904646","ref":"https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646","type":"User"}],"meta":{"resourceType":"Group","created":"2011-08-01T18:29:49.793Z","lastModified":"2011-08-01T20:31:02.315Z","location":"https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a"}}}},"components/schemas/updateGroupRequest":{"id":"components/schemas/updateGroupRequest","kind":"json-schema","title":"updateGroupRequest","data":{"allOf":[{"$ref":"#/components/schemas/Group"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"id":"2819c223-7f76-453a-919d-413861904646","displayName":"Tour Guides","members":[{"value":"92b725cd-9465-4e7d-8c16-01f8e146b87a","type":"User"}]}}},"components/schemas/updateGroupResponse":{"id":"components/schemas/updateGroupResponse","kind":"json-schema","title":"updateGroupResponse","data":{"allOf":[{"$ref":"#/components/schemas/Group"},{"$ref":"#/components/schemas/Meta"}],"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"id":"2819c223-7f76-453a-919d-413861904646","displayName":"Tour Guides","members":[{"value":"92b725cd-9465-4e7d-8c16-01f8e146b87a","ref":"https://example.com/v2/Users/92b725cd-9465-4e7d-8c16-01f8e146b87a","type":"User"}],"meta":{"resourceType":"Group","created":"2011-08-01T18:29:49.793Z","lastModified":"2011-08-01T20:31:02.315Z","location":"https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a"}}}},"components/schemas/bulkRequest":{"id":"components/schemas/bulkRequest","kind":"json-schema","title":"bulkRequest","data":{"allOf":[{"$ref":"#/components/schemas/BulkRequest"}],"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:BulkRequest"],"failOnErrors":1,"Operations":[{"method":"POST","path":"/Users","bulkId":"qwerty","data":{"schemas":["urn:ietf:params:scim:api:messages:2.0:User"],"userName":"Alice"}},{"method":"POST","path":"/Groups","bulkId":"ytrewq","data":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"displayName":"Tour Guides","members":[{"type":"User","value":"bulkId:qwerty"}]}},{"method":"PUT","path":"/Users/b7c14771-226c-4d05-8860-134711653041","data":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"b7c14771-226c-4d05-8860-134711653041","userName":"Bob"}},{"method":"PATCH","path":"/Users/5d8d29d3-342c-4b5f-8683-a3cb6763ffcc","data":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"remove","path":"nickName"},{"op":"add","path":"userName","value":"Dave"}]}},{"method":"DELETE","path":"/Users/e9025315-6bea-44e1-899c-1e07454e468b"}]}}},"components/schemas/bulkResponse":{"id":"components/schemas/bulkResponse","kind":"json-schema","title":"bulkResponse","data":{"allOf":[{"$ref":"#/components/schemas/BulkResponse"}],"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:BulkResponse"],"Operations":[{"location":"https://example.com/v2/Users/92b725cd-9465-4e7d-8c16-01f8e146b87a","method":"POST","bulkId":"qwerty","status":"201"},{"location":"https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a","method":"POST","bulkId":"ytrewq","status":"201"},{"location":"https://example.com/v2/Users/b7c14771-226c-4d05-8860-134711653041","method":"PUT","status":"200"},{"location":"https://example.com/v2/Users/5d8d29d3-342c-4b5f-8683-a3cb6763ffcc","method":"PATCH","status":"200"},{"location":"https://example.com/v2/Users/e9025315-6bea-44e1-899c-1e07454e468b","method":"DELETE","status":"204"}]}}},"schema_110":{"kind":"json-schema","data":{"type":"string"},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","default":"404"},"detail":{"type":"string","default":"Resource {id} not found"}}},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"string","enum":["ascending","descending"]},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_114"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","isMockServer":true,"description":"Mock server"}],"logo":{"imageUrl":"_images/scim-api.png","href":"https://www.reachfive.com/contact-us"}},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/catalog/api-showdown/api-hub/admin/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/catalog/api-showdown/api-hub/Admin/openapi.json?download"},{"url":"/_bundle/catalog/api-showdown/api-hub/Admin/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"ReachFive SCIM API","description":"> #### <i class=\"fa fa-gear fa-spin fa-2x\" style=\"color: #00c24a\"></i> BETA RELEASE\n> A beta release is the first offering of the feature and may not be fully available to all customers. Contact your ReachFive representative for more details.\n\nThe SCIM protocol is an application-level REST protocol for provisioning and managing identity data on the web.\nIt supports creating, discovering, retrieving, and modifying core identity resources.\n\n**Note**: For more on SCIM, please see [here](https://www.rfc-editor.org/rfc/rfc7644).\n"}},"baseSlug":"/catalog/api-showdown/api-hub/admin/openapi","routesMapping":{}}