{ "/scim/v2": { "get": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Get Scim Base", "description": "Base SCIM v2 endpoint for resource discovery per RFC 7644 Section 4.\n\nReturns a ListResponse of ResourceTypes supported by this SCIM service provider.\nIdentity providers (Okta, Azure AD, etc.) use this endpoint for resource discovery.", "operationId": "get_scim_base_scim_v2_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scim/v2/Groups": { "get": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Get Groups", "description": "Get a list of groups according to SCIM v2 protocol", "operationId": "get_groups_scim_v2_Groups_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Startindex" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10, "title": "Count" } }, { "name": "filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Create Group", "description": "Create a group according to SCIM v2 protocol", "operationId": "create_group_scim_v2_Groups_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMGroup" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMGroup" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scim/v2/Groups/{group_id}": { "get": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Get Group", "description": "Get a single group by ID according to SCIM v2 protocol", "operationId": "get_group_scim_v2_Groups__group_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Group ID" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMGroup" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Update Group", "description": "Update a group according to SCIM v2 protocol", "operationId": "update_group_scim_v2_Groups__group_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Group ID" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMGroup" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMGroup" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Delete Group", "description": "Delete a group according to SCIM v2 protocol", "operationId": "delete_group_scim_v2_Groups__group_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Group ID" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Patch Group", "description": "Patch a group according to SCIM v2 protocol", "operationId": "patch_group_scim_v2_Groups__group_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Group ID" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMPatchOp" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMGroup" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scim/v2/ResourceTypes": { "get": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Get Resource Types", "description": "SCIM ResourceTypes endpoint per RFC 7644 Section 4.\n\nReturns a ListResponse of all resource types supported by this service provider.", "operationId": "get_resource_types_scim_v2_ResourceTypes_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scim/v2/ResourceTypes/{resource_type_id}": { "get": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Get Resource Type", "description": "Get a single ResourceType by ID per RFC 7644.", "operationId": "get_resource_type_scim_v2_ResourceTypes__resource_type_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "resource_type_id", "in": "path", "required": true, "schema": { "type": "string", "title": "ResourceType ID" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scim/v2/Schemas": { "get": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Get Schemas", "description": "SCIM Schemas endpoint per RFC 7643 Section 7.\n\nReturns a ListResponse of all schemas supported by this service provider.", "operationId": "get_schemas_scim_v2_Schemas_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scim/v2/Schemas/{schema_id}": { "get": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Get Schema", "description": "Get a single Schema by its URI per RFC 7643 Section 7.", "operationId": "get_schema_scim_v2_Schemas__schema_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "schema_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schema URI" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scim/v2/ServiceProviderConfig": { "get": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Get Service Provider Config", "description": "Return SCIM Service Provider Configuration.", "operationId": "get_service_provider_config_scim_v2_ServiceProviderConfig_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMServiceProviderConfig" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scim/v2/Users": { "get": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Get Users", "description": "Get a list of users according to SCIM v2 protocol", "operationId": "get_users_scim_v2_Users_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Startindex" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10, "title": "Count" } }, { "name": "filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Create User", "description": "Create a user according to SCIM v2 protocol", "operationId": "create_user_scim_v2_Users_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMUser" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMUser" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scim/v2/Users/{user_id}": { "get": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Get User", "description": "Get a single user by ID according to SCIM v2 protocol", "operationId": "get_user_scim_v2_Users__user_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User ID" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMUser" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Update User", "description": "Update a user according to SCIM v2 protocol (full replacement)", "operationId": "update_user_scim_v2_Users__user_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User ID" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMUser" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMUser" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Delete User", "description": "Delete a user according to SCIM v2 protocol", "operationId": "delete_user_scim_v2_Users__user_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User ID" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "\u2728 SCIM v2 (Enterprise Only)" ], "summary": "Patch User", "description": "Patch a user according to SCIM v2 protocol", "operationId": "patch_user_scim_v2_Users__user_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User ID" } }, { "name": "feature", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMPatchOp" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMUser" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }