ScimGroupsApi.md

openapi.api.ScimGroupsApi

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
groupsCreateObjectScimV2	POST /2/scim/Groups	Create a new Usergroup
groupsDeleteObjectScimV2	DELETE /2/scim/Groups/{groupId}	Delete an existing Usergroup
groupsEditObjectScimV2	PUT /2/scim/Groups/{groupId}	Edit an existing Usergroup
groupsGetListScimV2	GET /2/scim/Groups	Retrieve Usergroup list
groupsGetObjectScimV2	GET /2/scim/Groups/{groupId}	Retrieve an existing Usergroup

groupsCreateObjectScimV2

ScimGroup groupsCreateObjectScimV2(scimGroup)

Create a new Usergroup

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 = ScimGroupsApi();
final scimGroup = ScimGroup(); // ScimGroup | 

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

Parameters

Name	Type	Description	Notes
scimGroup	ScimGroup

Return type

ScimGroup

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]

groupsDeleteObjectScimV2

groupsDeleteObjectScimV2(groupId)

Delete an existing Usergroup

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 = ScimGroupsApi();
final groupId = groupId_example; // String | 

try {
    api_instance.groupsDeleteObjectScimV2(groupId);
} catch (e) {
    print('Exception when calling ScimGroupsApi->groupsDeleteObjectScimV2: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	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]

groupsEditObjectScimV2

ScimGroup groupsEditObjectScimV2(groupId, scimGroup)

Edit an existing Usergroup

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 = ScimGroupsApi();
final groupId = groupId_example; // String | 
final scimGroup = ScimGroup(); // ScimGroup | 

try {
    final result = api_instance.groupsEditObjectScimV2(groupId, scimGroup);
    print(result);
} catch (e) {
    print('Exception when calling ScimGroupsApi->groupsEditObjectScimV2: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String
scimGroup	ScimGroup

Return type

ScimGroup

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]

groupsGetListScimV2

ScimGroup groupsGetListScimV2(filter)

Retrieve Usergroup 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 = ScimGroupsApi();
final filter = filter_example; // String | Filter expression for searching groups

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

Parameters

Name	Type	Description	Notes
filter	String	Filter expression for searching groups	[optional]

Return type

ScimGroup

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]

groupsGetObjectScimV2

ScimGroup groupsGetObjectScimV2(groupId)

Retrieve an existing Usergroup

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 = ScimGroupsApi();
final groupId = groupId_example; // String | 

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

Parameters

Name	Type	Description	Notes
groupId	String

Return type

ScimGroup

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]