Skip to content

Latest commit

 

History

History
254 lines (179 loc) · 7.45 KB

ScimUsersApi.md

File metadata and controls

254 lines (179 loc) · 7.45 KB

openapi.api.ScimUsersApi

Load the API package

import 'package:openapi/api.dart';

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 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: Bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ScimUsersApi();
final scimUser = ScimUser(); // ScimUser | 

try {
    final result = api_instance.usersCreateObjectScimV2(scimUser);
    print(result);
} catch (e) {
    print('Exception when calling ScimUsersApi->usersCreateObjectScimV2: $e\n');
}

Parameters

Name Type Description Notes
scimUser ScimUser

Return type

ScimUser

Authorization

Bearer

HTTP request headers

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

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

usersDeleteObjectScimV2

usersDeleteObjectScimV2(userId)

Delete an existing User

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: Bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ScimUsersApi();
final userId = userId_example; // String | 

try {
    api_instance.usersDeleteObjectScimV2(userId);
} catch (e) {
    print('Exception when calling ScimUsersApi->usersDeleteObjectScimV2: $e\n');
}

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

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

usersEditObjectScimV2

ScimUser usersEditObjectScimV2(userId, scimUser)

Edit an existing User

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: Bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ScimUsersApi();
final userId = userId_example; // String | 
final scimUser = ScimUser(); // ScimUser | 

try {
    final result = api_instance.usersEditObjectScimV2(userId, scimUser);
    print(result);
} catch (e) {
    print('Exception when calling ScimUsersApi->usersEditObjectScimV2: $e\n');
}

Parameters

Name Type Description Notes
userId String
scimUser ScimUser

Return type

ScimUser

Authorization

Bearer

HTTP request headers

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

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

usersGetListScimV2

ScimUserList usersGetListScimV2(filter)

Retrieve User list

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: Bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ScimUsersApi();
final filter = filter_example; // String | Filter expression for searching users

try {
    final result = api_instance.usersGetListScimV2(filter);
    print(result);
} catch (e) {
    print('Exception when calling ScimUsersApi->usersGetListScimV2: $e\n');
}

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

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

usersGetObjectScimV2

ScimUser usersGetObjectScimV2(userId)

Retrieve an existing User

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: Bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ScimUsersApi();
final userId = userId_example; // String | 

try {
    final result = api_instance.usersGetObjectScimV2(userId);
    print(result);
} catch (e) {
    print('Exception when calling ScimUsersApi->usersGetObjectScimV2: $e\n');
}

Parameters

Name Type Description Notes
userId String

Return type

ScimUser

Authorization

Bearer

HTTP request headers

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

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