ScimUsersApi.md

EZmaxApiDefinitionFull.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)

Create a new User

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure Bearer access token for authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new EZmaxApiDefinitionFull.ScimUsersApi();
let ScimUser = new EZmaxApiDefinitionFull.ScimUser(); // ScimUser | 
apiInstance.usersCreateObjectScimV2(ScimUser, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
ScimUser	ScimUser

Return type

ScimUser

Authorization

Bearer

HTTP request headers

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

usersDeleteObjectScimV2

usersDeleteObjectScimV2(userId)

Delete an existing User

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure Bearer access token for authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new EZmaxApiDefinitionFull.ScimUsersApi();
let userId = "userId_example"; // String | 
apiInstance.usersDeleteObjectScimV2(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
userId	String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

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

usersEditObjectScimV2

ScimUser usersEditObjectScimV2(userId, ScimUser)

Edit an existing User

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure Bearer access token for authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new EZmaxApiDefinitionFull.ScimUsersApi();
let userId = "userId_example"; // String | 
let ScimUser = new EZmaxApiDefinitionFull.ScimUser(); // ScimUser | 
apiInstance.usersEditObjectScimV2(userId, ScimUser, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
userId	String
ScimUser	ScimUser

Return type

ScimUser

Authorization

Bearer

HTTP request headers

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

usersGetListScimV2

ScimUserList usersGetListScimV2(opts)

Retrieve User list

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure Bearer access token for authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new EZmaxApiDefinitionFull.ScimUsersApi();
let opts = {
  'filter': "filter_example" // String | Filter expression for searching users
};
apiInstance.usersGetListScimV2(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

usersGetObjectScimV2

ScimUser usersGetObjectScimV2(userId)

Retrieve an existing User

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure Bearer access token for authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new EZmaxApiDefinitionFull.ScimUsersApi();
let userId = "userId_example"; // String | 
apiInstance.usersGetObjectScimV2(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
userId	String

Return type

ScimUser

Authorization

Bearer

HTTP request headers

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