Skip to content

ScimApi.md

Latest commit

 

History

History
218 lines (112 loc) · 5.87 KB

ScimApi.md

File metadata and controls

218 lines (112 loc) · 5.87 KB

\ScimApi

All URIs are relative to http://localhost

Method HTTP request Description
scim_create_user POST /api/public/scim/Users
scim_delete_user DELETE /api/public/scim/Users/{userId}
scim_get_resource_types GET /api/public/scim/ResourceTypes
scim_get_schemas GET /api/public/scim/Schemas
scim_get_service_provider_config GET /api/public/scim/ServiceProviderConfig
scim_get_user GET /api/public/scim/Users/{userId}
scim_list_users GET /api/public/scim/Users

scim_create_user

models::ScimUser scim_create_user(scim_create_user_request)

Create a new user in the organization (requires organization-scoped API key)

Parameters

Name Type Description Required Notes
scim_create_user_request ScimCreateUserRequest [required]

Return type

models::ScimUser

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

scim_delete_user

serde_json::Value scim_delete_user(user_id)

Remove a user from the organization (requires organization-scoped API key). Note that this only removes the user from the organization but does not delete the user entity itself.

Parameters

Name Type Description Required Notes
user_id String [required]

Return type

serde_json::Value

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

scim_get_resource_types

models::ResourceTypesResponse scim_get_resource_types()

Get SCIM Resource Types (requires organization-scoped API key)

Parameters

This endpoint does not need any parameter.

Return type

models::ResourceTypesResponse

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

scim_get_schemas

models::SchemasResponse scim_get_schemas()

Get SCIM Schemas (requires organization-scoped API key)

Parameters

This endpoint does not need any parameter.

Return type

models::SchemasResponse

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

scim_get_service_provider_config

models::ServiceProviderConfig scim_get_service_provider_config()

Get SCIM Service Provider Configuration (requires organization-scoped API key)

Parameters

This endpoint does not need any parameter.

Return type

models::ServiceProviderConfig

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

scim_get_user

models::ScimUser scim_get_user(user_id)

Get a specific user by ID (requires organization-scoped API key)

Parameters

Name Type Description Required Notes
user_id String [required]

Return type

models::ScimUser

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

scim_list_users

models::ScimUsersListResponse scim_list_users(filter, start_index, count)

List users in the organization (requires organization-scoped API key)

Parameters

Name Type Description Required Notes
filter Option<String> Filter expression (e.g. userName eq "value")
start_index Option<i32> 1-based index of the first result to return (default 1)
count Option<i32> Maximum number of results to return (default 100)

Return type

models::ScimUsersListResponse

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]