Skip to content

Files

Latest commit

author
Api (Codebuild)
Look for details in API documentation's changelog
Jan 30, 2025
dd5f8fa · Jan 30, 2025

History

History
470 lines (372 loc) · 13.5 KB

ScimUsersApi.md

File metadata and controls

470 lines (372 loc) · 13.5 KB

eZmaxApi.Api.ScimUsersApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
UsersCreateObjectScimV2 POST /2/scim/Users Create a new User
UsersDeleteObjectScimV2 DELETE /2/scim/Users/{userId} Delete an existing User
UsersEditObjectScimV2 PUT /2/scim/Users/{userId} Edit an existing User
UsersGetListScimV2 GET /2/scim/Users Retrieve User list
UsersGetObjectScimV2 GET /2/scim/Users/{userId} Retrieve an existing User

UsersCreateObjectScimV2

ScimUser UsersCreateObjectScimV2 (ScimUser scimUser)

Create a new User

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class UsersCreateObjectScimV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure Bearer token for authorization: Bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new ScimUsersApi(config);
            var scimUser = new ScimUser(); // ScimUser | 

            try
            {
                // Create a new User
                ScimUser result = apiInstance.UsersCreateObjectScimV2(scimUser);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ScimUsersApi.UsersCreateObjectScimV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UsersCreateObjectScimV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Create a new User
    ApiResponse<ScimUser> response = apiInstance.UsersCreateObjectScimV2WithHttpInfo(scimUser);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ScimUsersApi.UsersCreateObjectScimV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
scimUser ScimUser

Return type

ScimUser

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Created -

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

UsersDeleteObjectScimV2

void UsersDeleteObjectScimV2 (string userId)

Delete an existing User

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class UsersDeleteObjectScimV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure Bearer token for authorization: Bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new ScimUsersApi(config);
            var userId = "userId_example";  // string | 

            try
            {
                // Delete an existing User
                apiInstance.UsersDeleteObjectScimV2(userId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ScimUsersApi.UsersDeleteObjectScimV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UsersDeleteObjectScimV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Delete an existing User
    apiInstance.UsersDeleteObjectScimV2WithHttpInfo(userId);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ScimUsersApi.UsersDeleteObjectScimV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
userId string

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -

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

UsersEditObjectScimV2

ScimUser UsersEditObjectScimV2 (string userId, ScimUser scimUser)

Edit an existing User

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class UsersEditObjectScimV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure Bearer token for authorization: Bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new ScimUsersApi(config);
            var userId = "userId_example";  // string | 
            var scimUser = new ScimUser(); // ScimUser | 

            try
            {
                // Edit an existing User
                ScimUser result = apiInstance.UsersEditObjectScimV2(userId, scimUser);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ScimUsersApi.UsersEditObjectScimV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UsersEditObjectScimV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Edit an existing User
    ApiResponse<ScimUser> response = apiInstance.UsersEditObjectScimV2WithHttpInfo(userId, scimUser);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ScimUsersApi.UsersEditObjectScimV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
userId string
scimUser ScimUser

Return type

ScimUser

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

UsersGetListScimV2

ScimUserList UsersGetListScimV2 (string? filter = null)

Retrieve User list

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class UsersGetListScimV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure Bearer token for authorization: Bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new ScimUsersApi(config);
            var filter = "filter_example";  // string? | Filter expression for searching users (optional) 

            try
            {
                // Retrieve User list
                ScimUserList result = apiInstance.UsersGetListScimV2(filter);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ScimUsersApi.UsersGetListScimV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UsersGetListScimV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve User list
    ApiResponse<ScimUserList> response = apiInstance.UsersGetListScimV2WithHttpInfo(filter);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ScimUsersApi.UsersGetListScimV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
filter string? Filter expression for searching users [optional]

Return type

ScimUserList

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

UsersGetObjectScimV2

ScimUser UsersGetObjectScimV2 (string userId)

Retrieve an existing User

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class UsersGetObjectScimV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure Bearer token for authorization: Bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new ScimUsersApi(config);
            var userId = "userId_example";  // string | 

            try
            {
                // Retrieve an existing User
                ScimUser result = apiInstance.UsersGetObjectScimV2(userId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ScimUsersApi.UsersGetObjectScimV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UsersGetObjectScimV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve an existing User
    ApiResponse<ScimUser> response = apiInstance.UsersGetObjectScimV2WithHttpInfo(userId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ScimUsersApi.UsersGetObjectScimV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
userId string

Return type

ScimUser

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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