Documentation

SCIMApi
in package

MailSlurp

SCIMApi Class Doc Comment

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['createGroup' => ['application/scim+json', 'application/json'], 'createUser' => ['application/scim+json', 'application/json'], 'deleteGroup' => ['application/json'], 'deleteUser' => ['application/json'], 'getGroup' => ['application/json'], 'getResourceType' => ['application/json'], 'getResourceTypes' => ['application/json'], 'getSchema' => ['application/json'], 'getSchemas' => ['application/json'], 'getServiceProviderConfig' => ['application/json'], 'getUser' => ['application/json'], 'listGroups' => ['application/json'], 'listUsers' => ['application/json'], 'patchGroup' => ['application/scim+json', 'application/json'], 'patchUser' => ['application/scim+json', 'application/json'], 'replaceGroup' => ['application/scim+json', 'application/json'], 'replaceUser' => ['application/scim+json', 'application/json']]

$client


    protected
        ClientInterface
    $client

$config


    protected
        Configuration
    $config

$headerSelector


    protected
        HeaderSelector
    $headerSelector

$hostIndex


    protected
        int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values

mixed —

createGroup()

Operation createGroup


    public
                    createGroup(string $slug, ScimGroupResource $scim_group_resource[, string $contentType = self::contentTypes['createGroup'][0] ]) : object

Parameters

$slug : string: slug (required)
$scim_group_resource : ScimGroupResource: scim_group_resource (required)
$contentType : string = self::contentTypes['createGroup'][0]: The value for the Content-Type header. Check self::contentTypes['createGroup'] to see the possible values for this operation

Return values

object —

createGroupAsync()

Operation createGroupAsync


    public
                    createGroupAsync(string $slug, ScimGroupResource $scim_group_resource[, string $contentType = self::contentTypes['createGroup'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$scim_group_resource : ScimGroupResource: (required)
$contentType : string = self::contentTypes['createGroup'][0]: The value for the Content-Type header. Check self::contentTypes['createGroup'] to see the possible values for this operation

Return values

PromiseInterface —

createGroupAsyncWithHttpInfo()

Operation createGroupAsyncWithHttpInfo


    public
                    createGroupAsyncWithHttpInfo(string $slug, ScimGroupResource $scim_group_resource[, string $contentType = self::contentTypes['createGroup'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$scim_group_resource : ScimGroupResource: (required)
$contentType : string = self::contentTypes['createGroup'][0]: The value for the Content-Type header. Check self::contentTypes['createGroup'] to see the possible values for this operation

Return values

PromiseInterface —

createGroupRequest()

Create request for operation 'createGroup'


    public
                    createGroupRequest(string $slug, ScimGroupResource $scim_group_resource[, string $contentType = self::contentTypes['createGroup'][0] ]) : Request

Parameters

$slug : string: (required)
$scim_group_resource : ScimGroupResource: (required)
$contentType : string = self::contentTypes['createGroup'][0]: The value for the Content-Type header. Check self::contentTypes['createGroup'] to see the possible values for this operation

Return values

Request —

createGroupWithHttpInfo()

Operation createGroupWithHttpInfo


    public
                    createGroupWithHttpInfo(string $slug, ScimGroupResource $scim_group_resource[, string $contentType = self::contentTypes['createGroup'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$scim_group_resource : ScimGroupResource: (required)
$contentType : string = self::contentTypes['createGroup'][0]: The value for the Content-Type header. Check self::contentTypes['createGroup'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createUser()

Operation createUser


    public
                    createUser(string $slug, ScimUserResource $scim_user_resource[, string $contentType = self::contentTypes['createUser'][0] ]) : object

Parameters

$slug : string: slug (required)
$scim_user_resource : ScimUserResource: scim_user_resource (required)
$contentType : string = self::contentTypes['createUser'][0]: The value for the Content-Type header. Check self::contentTypes['createUser'] to see the possible values for this operation

Return values

object —

createUserAsync()

Operation createUserAsync


    public
                    createUserAsync(string $slug, ScimUserResource $scim_user_resource[, string $contentType = self::contentTypes['createUser'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$scim_user_resource : ScimUserResource: (required)
$contentType : string = self::contentTypes['createUser'][0]: The value for the Content-Type header. Check self::contentTypes['createUser'] to see the possible values for this operation

Return values

PromiseInterface —

createUserAsyncWithHttpInfo()

Operation createUserAsyncWithHttpInfo


    public
                    createUserAsyncWithHttpInfo(string $slug, ScimUserResource $scim_user_resource[, string $contentType = self::contentTypes['createUser'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$scim_user_resource : ScimUserResource: (required)
$contentType : string = self::contentTypes['createUser'][0]: The value for the Content-Type header. Check self::contentTypes['createUser'] to see the possible values for this operation

Return values

PromiseInterface —

createUserRequest()

Create request for operation 'createUser'


    public
                    createUserRequest(string $slug, ScimUserResource $scim_user_resource[, string $contentType = self::contentTypes['createUser'][0] ]) : Request

Parameters

$slug : string: (required)
$scim_user_resource : ScimUserResource: (required)
$contentType : string = self::contentTypes['createUser'][0]: The value for the Content-Type header. Check self::contentTypes['createUser'] to see the possible values for this operation

Return values

Request —

createUserWithHttpInfo()

Operation createUserWithHttpInfo


    public
                    createUserWithHttpInfo(string $slug, ScimUserResource $scim_user_resource[, string $contentType = self::contentTypes['createUser'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$scim_user_resource : ScimUserResource: (required)
$contentType : string = self::contentTypes['createUser'][0]: The value for the Content-Type header. Check self::contentTypes['createUser'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

deleteGroup()

Operation deleteGroup


    public
                    deleteGroup(string $slug, string $group_id[, string $contentType = self::contentTypes['deleteGroup'][0] ]) : object

Parameters

$slug : string: slug (required)
$group_id : string: group_id (required)
$contentType : string = self::contentTypes['deleteGroup'][0]: The value for the Content-Type header. Check self::contentTypes['deleteGroup'] to see the possible values for this operation

Return values

object —

deleteGroupAsync()

Operation deleteGroupAsync


    public
                    deleteGroupAsync(string $slug, string $group_id[, string $contentType = self::contentTypes['deleteGroup'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$group_id : string: (required)
$contentType : string = self::contentTypes['deleteGroup'][0]: The value for the Content-Type header. Check self::contentTypes['deleteGroup'] to see the possible values for this operation

Return values

PromiseInterface —

deleteGroupAsyncWithHttpInfo()

Operation deleteGroupAsyncWithHttpInfo


    public
                    deleteGroupAsyncWithHttpInfo(string $slug, string $group_id[, string $contentType = self::contentTypes['deleteGroup'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$group_id : string: (required)
$contentType : string = self::contentTypes['deleteGroup'][0]: The value for the Content-Type header. Check self::contentTypes['deleteGroup'] to see the possible values for this operation

Return values

PromiseInterface —

deleteGroupRequest()

Create request for operation 'deleteGroup'


    public
                    deleteGroupRequest(string $slug, string $group_id[, string $contentType = self::contentTypes['deleteGroup'][0] ]) : Request

Parameters

$slug : string: (required)
$group_id : string: (required)
$contentType : string = self::contentTypes['deleteGroup'][0]: The value for the Content-Type header. Check self::contentTypes['deleteGroup'] to see the possible values for this operation

Return values

Request —

deleteGroupWithHttpInfo()

Operation deleteGroupWithHttpInfo


    public
                    deleteGroupWithHttpInfo(string $slug, string $group_id[, string $contentType = self::contentTypes['deleteGroup'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$group_id : string: (required)
$contentType : string = self::contentTypes['deleteGroup'][0]: The value for the Content-Type header. Check self::contentTypes['deleteGroup'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

deleteUser()

Operation deleteUser


    public
                    deleteUser(string $slug, string $user_id[, string $contentType = self::contentTypes['deleteUser'][0] ]) : object

Parameters

$slug : string: slug (required)
$user_id : string: user_id (required)
$contentType : string = self::contentTypes['deleteUser'][0]: The value for the Content-Type header. Check self::contentTypes['deleteUser'] to see the possible values for this operation

Return values

object —

deleteUserAsync()

Operation deleteUserAsync


    public
                    deleteUserAsync(string $slug, string $user_id[, string $contentType = self::contentTypes['deleteUser'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$user_id : string: (required)
$contentType : string = self::contentTypes['deleteUser'][0]: The value for the Content-Type header. Check self::contentTypes['deleteUser'] to see the possible values for this operation

Return values

PromiseInterface —

deleteUserAsyncWithHttpInfo()

Operation deleteUserAsyncWithHttpInfo


    public
                    deleteUserAsyncWithHttpInfo(string $slug, string $user_id[, string $contentType = self::contentTypes['deleteUser'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$user_id : string: (required)
$contentType : string = self::contentTypes['deleteUser'][0]: The value for the Content-Type header. Check self::contentTypes['deleteUser'] to see the possible values for this operation

Return values

PromiseInterface —

deleteUserRequest()

Create request for operation 'deleteUser'


    public
                    deleteUserRequest(string $slug, string $user_id[, string $contentType = self::contentTypes['deleteUser'][0] ]) : Request

Parameters

$slug : string: (required)
$user_id : string: (required)
$contentType : string = self::contentTypes['deleteUser'][0]: The value for the Content-Type header. Check self::contentTypes['deleteUser'] to see the possible values for this operation

Return values

Request —

deleteUserWithHttpInfo()

Operation deleteUserWithHttpInfo


    public
                    deleteUserWithHttpInfo(string $slug, string $user_id[, string $contentType = self::contentTypes['deleteUser'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$user_id : string: (required)
$contentType : string = self::contentTypes['deleteUser'][0]: The value for the Content-Type header. Check self::contentTypes['deleteUser'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration —

getGroup()

Operation getGroup


    public
                    getGroup(string $slug, string $group_id[, string $contentType = self::contentTypes['getGroup'][0] ]) : object

Parameters

$slug : string: slug (required)
$group_id : string: group_id (required)
$contentType : string = self::contentTypes['getGroup'][0]: The value for the Content-Type header. Check self::contentTypes['getGroup'] to see the possible values for this operation

Return values

object —

getGroupAsync()

Operation getGroupAsync


    public
                    getGroupAsync(string $slug, string $group_id[, string $contentType = self::contentTypes['getGroup'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$group_id : string: (required)
$contentType : string = self::contentTypes['getGroup'][0]: The value for the Content-Type header. Check self::contentTypes['getGroup'] to see the possible values for this operation

Return values

PromiseInterface —

getGroupAsyncWithHttpInfo()

Operation getGroupAsyncWithHttpInfo


    public
                    getGroupAsyncWithHttpInfo(string $slug, string $group_id[, string $contentType = self::contentTypes['getGroup'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$group_id : string: (required)
$contentType : string = self::contentTypes['getGroup'][0]: The value for the Content-Type header. Check self::contentTypes['getGroup'] to see the possible values for this operation

Return values

PromiseInterface —

getGroupRequest()

Create request for operation 'getGroup'


    public
                    getGroupRequest(string $slug, string $group_id[, string $contentType = self::contentTypes['getGroup'][0] ]) : Request

Parameters

$slug : string: (required)
$group_id : string: (required)
$contentType : string = self::contentTypes['getGroup'][0]: The value for the Content-Type header. Check self::contentTypes['getGroup'] to see the possible values for this operation

Return values

Request —

getGroupWithHttpInfo()

Operation getGroupWithHttpInfo


    public
                    getGroupWithHttpInfo(string $slug, string $group_id[, string $contentType = self::contentTypes['getGroup'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$group_id : string: (required)
$contentType : string = self::contentTypes['getGroup'][0]: The value for the Content-Type header. Check self::contentTypes['getGroup'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

getResourceType()

Operation getResourceType


    public
                    getResourceType(string $slug, string $resource_type[, string $contentType = self::contentTypes['getResourceType'][0] ]) : object

Parameters

$slug : string: slug (required)
$resource_type : string: resource_type (required)
$contentType : string = self::contentTypes['getResourceType'][0]: The value for the Content-Type header. Check self::contentTypes['getResourceType'] to see the possible values for this operation

Return values

object —

getResourceTypeAsync()

Operation getResourceTypeAsync


    public
                    getResourceTypeAsync(string $slug, string $resource_type[, string $contentType = self::contentTypes['getResourceType'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$resource_type : string: (required)
$contentType : string = self::contentTypes['getResourceType'][0]: The value for the Content-Type header. Check self::contentTypes['getResourceType'] to see the possible values for this operation

Return values

PromiseInterface —

getResourceTypeAsyncWithHttpInfo()

Operation getResourceTypeAsyncWithHttpInfo


    public
                    getResourceTypeAsyncWithHttpInfo(string $slug, string $resource_type[, string $contentType = self::contentTypes['getResourceType'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$resource_type : string: (required)
$contentType : string = self::contentTypes['getResourceType'][0]: The value for the Content-Type header. Check self::contentTypes['getResourceType'] to see the possible values for this operation

Return values

PromiseInterface —

getResourceTypeRequest()

Create request for operation 'getResourceType'


    public
                    getResourceTypeRequest(string $slug, string $resource_type[, string $contentType = self::contentTypes['getResourceType'][0] ]) : Request

Parameters

$slug : string: (required)
$resource_type : string: (required)
$contentType : string = self::contentTypes['getResourceType'][0]: The value for the Content-Type header. Check self::contentTypes['getResourceType'] to see the possible values for this operation

Return values

Request —

getResourceTypes()

Operation getResourceTypes


    public
                    getResourceTypes(string $slug[, string $contentType = self::contentTypes['getResourceTypes'][0] ]) : object

Parameters

$slug : string: slug (required)
$contentType : string = self::contentTypes['getResourceTypes'][0]: The value for the Content-Type header. Check self::contentTypes['getResourceTypes'] to see the possible values for this operation

Return values

object —

getResourceTypesAsync()

Operation getResourceTypesAsync


    public
                    getResourceTypesAsync(string $slug[, string $contentType = self::contentTypes['getResourceTypes'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getResourceTypes'][0]: The value for the Content-Type header. Check self::contentTypes['getResourceTypes'] to see the possible values for this operation

Return values

PromiseInterface —

getResourceTypesAsyncWithHttpInfo()

Operation getResourceTypesAsyncWithHttpInfo


    public
                    getResourceTypesAsyncWithHttpInfo(string $slug[, string $contentType = self::contentTypes['getResourceTypes'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getResourceTypes'][0]: The value for the Content-Type header. Check self::contentTypes['getResourceTypes'] to see the possible values for this operation

Return values

PromiseInterface —

getResourceTypesRequest()

Create request for operation 'getResourceTypes'


    public
                    getResourceTypesRequest(string $slug[, string $contentType = self::contentTypes['getResourceTypes'][0] ]) : Request

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getResourceTypes'][0]: The value for the Content-Type header. Check self::contentTypes['getResourceTypes'] to see the possible values for this operation

Return values

Request —

getResourceTypesWithHttpInfo()

Operation getResourceTypesWithHttpInfo


    public
                    getResourceTypesWithHttpInfo(string $slug[, string $contentType = self::contentTypes['getResourceTypes'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getResourceTypes'][0]: The value for the Content-Type header. Check self::contentTypes['getResourceTypes'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getResourceTypeWithHttpInfo()

Operation getResourceTypeWithHttpInfo


    public
                    getResourceTypeWithHttpInfo(string $slug, string $resource_type[, string $contentType = self::contentTypes['getResourceType'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$resource_type : string: (required)
$contentType : string = self::contentTypes['getResourceType'][0]: The value for the Content-Type header. Check self::contentTypes['getResourceType'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getSchema()

Operation getSchema


    public
                    getSchema(string $slug, string $schema_id[, string $contentType = self::contentTypes['getSchema'][0] ]) : object

Parameters

$slug : string: slug (required)
$schema_id : string: schema_id (required)
$contentType : string = self::contentTypes['getSchema'][0]: The value for the Content-Type header. Check self::contentTypes['getSchema'] to see the possible values for this operation

Return values

object —

getSchemaAsync()

Operation getSchemaAsync


    public
                    getSchemaAsync(string $slug, string $schema_id[, string $contentType = self::contentTypes['getSchema'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$schema_id : string: (required)
$contentType : string = self::contentTypes['getSchema'][0]: The value for the Content-Type header. Check self::contentTypes['getSchema'] to see the possible values for this operation

Return values

PromiseInterface —

getSchemaAsyncWithHttpInfo()

Operation getSchemaAsyncWithHttpInfo


    public
                    getSchemaAsyncWithHttpInfo(string $slug, string $schema_id[, string $contentType = self::contentTypes['getSchema'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$schema_id : string: (required)
$contentType : string = self::contentTypes['getSchema'][0]: The value for the Content-Type header. Check self::contentTypes['getSchema'] to see the possible values for this operation

Return values

PromiseInterface —

getSchemaRequest()

Create request for operation 'getSchema'


    public
                    getSchemaRequest(string $slug, string $schema_id[, string $contentType = self::contentTypes['getSchema'][0] ]) : Request

Parameters

$slug : string: (required)
$schema_id : string: (required)
$contentType : string = self::contentTypes['getSchema'][0]: The value for the Content-Type header. Check self::contentTypes['getSchema'] to see the possible values for this operation

Return values

Request —

getSchemas()

Operation getSchemas


    public
                    getSchemas(string $slug[, string $contentType = self::contentTypes['getSchemas'][0] ]) : object

Parameters

$slug : string: slug (required)
$contentType : string = self::contentTypes['getSchemas'][0]: The value for the Content-Type header. Check self::contentTypes['getSchemas'] to see the possible values for this operation

Return values

object —

getSchemasAsync()

Operation getSchemasAsync


    public
                    getSchemasAsync(string $slug[, string $contentType = self::contentTypes['getSchemas'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getSchemas'][0]: The value for the Content-Type header. Check self::contentTypes['getSchemas'] to see the possible values for this operation

Return values

PromiseInterface —

getSchemasAsyncWithHttpInfo()

Operation getSchemasAsyncWithHttpInfo


    public
                    getSchemasAsyncWithHttpInfo(string $slug[, string $contentType = self::contentTypes['getSchemas'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getSchemas'][0]: The value for the Content-Type header. Check self::contentTypes['getSchemas'] to see the possible values for this operation

Return values

PromiseInterface —

getSchemasRequest()

Create request for operation 'getSchemas'


    public
                    getSchemasRequest(string $slug[, string $contentType = self::contentTypes['getSchemas'][0] ]) : Request

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getSchemas'][0]: The value for the Content-Type header. Check self::contentTypes['getSchemas'] to see the possible values for this operation

Return values

Request —

getSchemasWithHttpInfo()

Operation getSchemasWithHttpInfo


    public
                    getSchemasWithHttpInfo(string $slug[, string $contentType = self::contentTypes['getSchemas'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getSchemas'][0]: The value for the Content-Type header. Check self::contentTypes['getSchemas'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getSchemaWithHttpInfo()

Operation getSchemaWithHttpInfo


    public
                    getSchemaWithHttpInfo(string $slug, string $schema_id[, string $contentType = self::contentTypes['getSchema'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$schema_id : string: (required)
$contentType : string = self::contentTypes['getSchema'][0]: The value for the Content-Type header. Check self::contentTypes['getSchema'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getServiceProviderConfig()

Operation getServiceProviderConfig


    public
                    getServiceProviderConfig(string $slug[, string $contentType = self::contentTypes['getServiceProviderConfig'][0] ]) : object

Parameters

$slug : string: slug (required)
$contentType : string = self::contentTypes['getServiceProviderConfig'][0]: The value for the Content-Type header. Check self::contentTypes['getServiceProviderConfig'] to see the possible values for this operation

Return values

object —

getServiceProviderConfigAsync()

Operation getServiceProviderConfigAsync


    public
                    getServiceProviderConfigAsync(string $slug[, string $contentType = self::contentTypes['getServiceProviderConfig'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getServiceProviderConfig'][0]: The value for the Content-Type header. Check self::contentTypes['getServiceProviderConfig'] to see the possible values for this operation

Return values

PromiseInterface —

getServiceProviderConfigAsyncWithHttpInfo()

Operation getServiceProviderConfigAsyncWithHttpInfo


    public
                    getServiceProviderConfigAsyncWithHttpInfo(string $slug[, string $contentType = self::contentTypes['getServiceProviderConfig'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getServiceProviderConfig'][0]: The value for the Content-Type header. Check self::contentTypes['getServiceProviderConfig'] to see the possible values for this operation

Return values

PromiseInterface —

getServiceProviderConfigRequest()

Create request for operation 'getServiceProviderConfig'


    public
                    getServiceProviderConfigRequest(string $slug[, string $contentType = self::contentTypes['getServiceProviderConfig'][0] ]) : Request

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getServiceProviderConfig'][0]: The value for the Content-Type header. Check self::contentTypes['getServiceProviderConfig'] to see the possible values for this operation

Return values

Request —

getServiceProviderConfigWithHttpInfo()

Operation getServiceProviderConfigWithHttpInfo


    public
                    getServiceProviderConfigWithHttpInfo(string $slug[, string $contentType = self::contentTypes['getServiceProviderConfig'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$contentType : string = self::contentTypes['getServiceProviderConfig'][0]: The value for the Content-Type header. Check self::contentTypes['getServiceProviderConfig'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getUser()

Operation getUser


    public
                    getUser(string $slug, string $user_id[, string $contentType = self::contentTypes['getUser'][0] ]) : object

Parameters

$slug : string: slug (required)
$user_id : string: user_id (required)
$contentType : string = self::contentTypes['getUser'][0]: The value for the Content-Type header. Check self::contentTypes['getUser'] to see the possible values for this operation

Return values

object —

getUserAsync()

Operation getUserAsync


    public
                    getUserAsync(string $slug, string $user_id[, string $contentType = self::contentTypes['getUser'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$user_id : string: (required)
$contentType : string = self::contentTypes['getUser'][0]: The value for the Content-Type header. Check self::contentTypes['getUser'] to see the possible values for this operation

Return values

PromiseInterface —

getUserAsyncWithHttpInfo()

Operation getUserAsyncWithHttpInfo


    public
                    getUserAsyncWithHttpInfo(string $slug, string $user_id[, string $contentType = self::contentTypes['getUser'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$user_id : string: (required)
$contentType : string = self::contentTypes['getUser'][0]: The value for the Content-Type header. Check self::contentTypes['getUser'] to see the possible values for this operation

Return values

PromiseInterface —

getUserRequest()

Create request for operation 'getUser'


    public
                    getUserRequest(string $slug, string $user_id[, string $contentType = self::contentTypes['getUser'][0] ]) : Request

Parameters

$slug : string: (required)
$user_id : string: (required)
$contentType : string = self::contentTypes['getUser'][0]: The value for the Content-Type header. Check self::contentTypes['getUser'] to see the possible values for this operation

Return values

Request —

getUserWithHttpInfo()

Operation getUserWithHttpInfo


    public
                    getUserWithHttpInfo(string $slug, string $user_id[, string $contentType = self::contentTypes['getUser'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$user_id : string: (required)
$contentType : string = self::contentTypes['getUser'][0]: The value for the Content-Type header. Check self::contentTypes['getUser'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

listGroups()

Operation listGroups


    public
                    listGroups(string $slug[, string $filter = null ][, int $start_index = null ][, int $count = null ][, string $contentType = self::contentTypes['listGroups'][0] ]) : object

Parameters

$slug : string: slug (required)
$filter : string = null: filter (optional)
$start_index : int = null: start_index (optional)
$count : int = null: count (optional)
$contentType : string = self::contentTypes['listGroups'][0]: The value for the Content-Type header. Check self::contentTypes['listGroups'] to see the possible values for this operation

Return values

object —

listGroupsAsync()

Operation listGroupsAsync


    public
                    listGroupsAsync(string $slug[, string $filter = null ][, int $start_index = null ][, int $count = null ][, string $contentType = self::contentTypes['listGroups'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$filter : string = null: (optional)
$start_index : int = null: (optional)
$count : int = null: (optional)
$contentType : string = self::contentTypes['listGroups'][0]: The value for the Content-Type header. Check self::contentTypes['listGroups'] to see the possible values for this operation

Return values

PromiseInterface —

listGroupsAsyncWithHttpInfo()

Operation listGroupsAsyncWithHttpInfo


    public
                    listGroupsAsyncWithHttpInfo(string $slug[, string $filter = null ][, int $start_index = null ][, int $count = null ][, string $contentType = self::contentTypes['listGroups'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$filter : string = null: (optional)
$start_index : int = null: (optional)
$count : int = null: (optional)
$contentType : string = self::contentTypes['listGroups'][0]: The value for the Content-Type header. Check self::contentTypes['listGroups'] to see the possible values for this operation

Return values

PromiseInterface —

listGroupsRequest()

Create request for operation 'listGroups'


    public
                    listGroupsRequest(string $slug[, string $filter = null ][, int $start_index = null ][, int $count = null ][, string $contentType = self::contentTypes['listGroups'][0] ]) : Request

Parameters

$slug : string: (required)
$filter : string = null: (optional)
$start_index : int = null: (optional)
$count : int = null: (optional)
$contentType : string = self::contentTypes['listGroups'][0]: The value for the Content-Type header. Check self::contentTypes['listGroups'] to see the possible values for this operation

Return values

Request —

listGroupsWithHttpInfo()

Operation listGroupsWithHttpInfo


    public
                    listGroupsWithHttpInfo(string $slug[, string $filter = null ][, int $start_index = null ][, int $count = null ][, string $contentType = self::contentTypes['listGroups'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$filter : string = null: (optional)
$start_index : int = null: (optional)
$count : int = null: (optional)
$contentType : string = self::contentTypes['listGroups'][0]: The value for the Content-Type header. Check self::contentTypes['listGroups'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

listUsers()

Operation listUsers


    public
                    listUsers(string $slug[, string $filter = null ][, int $start_index = null ][, int $count = null ][, string $contentType = self::contentTypes['listUsers'][0] ]) : object

Parameters

$slug : string: slug (required)
$filter : string = null: filter (optional)
$start_index : int = null: start_index (optional)
$count : int = null: count (optional)
$contentType : string = self::contentTypes['listUsers'][0]: The value for the Content-Type header. Check self::contentTypes['listUsers'] to see the possible values for this operation

Return values

object —

listUsersAsync()

Operation listUsersAsync


    public
                    listUsersAsync(string $slug[, string $filter = null ][, int $start_index = null ][, int $count = null ][, string $contentType = self::contentTypes['listUsers'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$filter : string = null: (optional)
$start_index : int = null: (optional)
$count : int = null: (optional)
$contentType : string = self::contentTypes['listUsers'][0]: The value for the Content-Type header. Check self::contentTypes['listUsers'] to see the possible values for this operation

Return values

PromiseInterface —

listUsersAsyncWithHttpInfo()

Operation listUsersAsyncWithHttpInfo


    public
                    listUsersAsyncWithHttpInfo(string $slug[, string $filter = null ][, int $start_index = null ][, int $count = null ][, string $contentType = self::contentTypes['listUsers'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$filter : string = null: (optional)
$start_index : int = null: (optional)
$count : int = null: (optional)
$contentType : string = self::contentTypes['listUsers'][0]: The value for the Content-Type header. Check self::contentTypes['listUsers'] to see the possible values for this operation

Return values

PromiseInterface —

listUsersRequest()

Create request for operation 'listUsers'


    public
                    listUsersRequest(string $slug[, string $filter = null ][, int $start_index = null ][, int $count = null ][, string $contentType = self::contentTypes['listUsers'][0] ]) : Request

Parameters

$slug : string: (required)
$filter : string = null: (optional)
$start_index : int = null: (optional)
$count : int = null: (optional)
$contentType : string = self::contentTypes['listUsers'][0]: The value for the Content-Type header. Check self::contentTypes['listUsers'] to see the possible values for this operation

Return values

Request —

listUsersWithHttpInfo()

Operation listUsersWithHttpInfo


    public
                    listUsersWithHttpInfo(string $slug[, string $filter = null ][, int $start_index = null ][, int $count = null ][, string $contentType = self::contentTypes['listUsers'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$filter : string = null: (optional)
$start_index : int = null: (optional)
$count : int = null: (optional)
$contentType : string = self::contentTypes['listUsers'][0]: The value for the Content-Type header. Check self::contentTypes['listUsers'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

patchGroup()

Operation patchGroup


    public
                    patchGroup(string $slug, string $group_id, ScimPatchRequest $scim_patch_request[, string $contentType = self::contentTypes['patchGroup'][0] ]) : object

Parameters

$slug : string: slug (required)
$group_id : string: group_id (required)
$scim_patch_request : ScimPatchRequest: scim_patch_request (required)
$contentType : string = self::contentTypes['patchGroup'][0]: The value for the Content-Type header. Check self::contentTypes['patchGroup'] to see the possible values for this operation

Return values

object —

patchGroupAsync()

Operation patchGroupAsync


    public
                    patchGroupAsync(string $slug, string $group_id, ScimPatchRequest $scim_patch_request[, string $contentType = self::contentTypes['patchGroup'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$group_id : string: (required)
$scim_patch_request : ScimPatchRequest: (required)
$contentType : string = self::contentTypes['patchGroup'][0]: The value for the Content-Type header. Check self::contentTypes['patchGroup'] to see the possible values for this operation

Return values

PromiseInterface —

patchGroupAsyncWithHttpInfo()

Operation patchGroupAsyncWithHttpInfo


    public
                    patchGroupAsyncWithHttpInfo(string $slug, string $group_id, ScimPatchRequest $scim_patch_request[, string $contentType = self::contentTypes['patchGroup'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$group_id : string: (required)
$scim_patch_request : ScimPatchRequest: (required)
$contentType : string = self::contentTypes['patchGroup'][0]: The value for the Content-Type header. Check self::contentTypes['patchGroup'] to see the possible values for this operation

Return values

PromiseInterface —

patchGroupRequest()

Create request for operation 'patchGroup'


    public
                    patchGroupRequest(string $slug, string $group_id, ScimPatchRequest $scim_patch_request[, string $contentType = self::contentTypes['patchGroup'][0] ]) : Request

Parameters

$slug : string: (required)
$group_id : string: (required)
$scim_patch_request : ScimPatchRequest: (required)
$contentType : string = self::contentTypes['patchGroup'][0]: The value for the Content-Type header. Check self::contentTypes['patchGroup'] to see the possible values for this operation

Return values

Request —

patchGroupWithHttpInfo()

Operation patchGroupWithHttpInfo


    public
                    patchGroupWithHttpInfo(string $slug, string $group_id, ScimPatchRequest $scim_patch_request[, string $contentType = self::contentTypes['patchGroup'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$group_id : string: (required)
$scim_patch_request : ScimPatchRequest: (required)
$contentType : string = self::contentTypes['patchGroup'][0]: The value for the Content-Type header. Check self::contentTypes['patchGroup'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

patchUser()

Operation patchUser


    public
                    patchUser(string $slug, string $user_id, ScimPatchRequest $scim_patch_request[, string $contentType = self::contentTypes['patchUser'][0] ]) : object

Parameters

$slug : string: slug (required)
$user_id : string: user_id (required)
$scim_patch_request : ScimPatchRequest: scim_patch_request (required)
$contentType : string = self::contentTypes['patchUser'][0]: The value for the Content-Type header. Check self::contentTypes['patchUser'] to see the possible values for this operation

Return values

object —

patchUserAsync()

Operation patchUserAsync


    public
                    patchUserAsync(string $slug, string $user_id, ScimPatchRequest $scim_patch_request[, string $contentType = self::contentTypes['patchUser'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$user_id : string: (required)
$scim_patch_request : ScimPatchRequest: (required)
$contentType : string = self::contentTypes['patchUser'][0]: The value for the Content-Type header. Check self::contentTypes['patchUser'] to see the possible values for this operation

Return values

PromiseInterface —

patchUserAsyncWithHttpInfo()

Operation patchUserAsyncWithHttpInfo


    public
                    patchUserAsyncWithHttpInfo(string $slug, string $user_id, ScimPatchRequest $scim_patch_request[, string $contentType = self::contentTypes['patchUser'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$user_id : string: (required)
$scim_patch_request : ScimPatchRequest: (required)
$contentType : string = self::contentTypes['patchUser'][0]: The value for the Content-Type header. Check self::contentTypes['patchUser'] to see the possible values for this operation

Return values

PromiseInterface —

patchUserRequest()

Create request for operation 'patchUser'


    public
                    patchUserRequest(string $slug, string $user_id, ScimPatchRequest $scim_patch_request[, string $contentType = self::contentTypes['patchUser'][0] ]) : Request

Parameters

$slug : string: (required)
$user_id : string: (required)
$scim_patch_request : ScimPatchRequest: (required)
$contentType : string = self::contentTypes['patchUser'][0]: The value for the Content-Type header. Check self::contentTypes['patchUser'] to see the possible values for this operation

Return values

Request —

patchUserWithHttpInfo()

Operation patchUserWithHttpInfo


    public
                    patchUserWithHttpInfo(string $slug, string $user_id, ScimPatchRequest $scim_patch_request[, string $contentType = self::contentTypes['patchUser'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$user_id : string: (required)
$scim_patch_request : ScimPatchRequest: (required)
$contentType : string = self::contentTypes['patchUser'][0]: The value for the Content-Type header. Check self::contentTypes['patchUser'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

replaceGroup()

Operation replaceGroup


    public
                    replaceGroup(string $slug, string $group_id, ScimGroupResource $scim_group_resource[, string $contentType = self::contentTypes['replaceGroup'][0] ]) : object

Parameters

$slug : string: slug (required)
$group_id : string: group_id (required)
$scim_group_resource : ScimGroupResource: scim_group_resource (required)
$contentType : string = self::contentTypes['replaceGroup'][0]: The value for the Content-Type header. Check self::contentTypes['replaceGroup'] to see the possible values for this operation

Return values

object —

replaceGroupAsync()

Operation replaceGroupAsync


    public
                    replaceGroupAsync(string $slug, string $group_id, ScimGroupResource $scim_group_resource[, string $contentType = self::contentTypes['replaceGroup'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$group_id : string: (required)
$scim_group_resource : ScimGroupResource: (required)
$contentType : string = self::contentTypes['replaceGroup'][0]: The value for the Content-Type header. Check self::contentTypes['replaceGroup'] to see the possible values for this operation

Return values

PromiseInterface —

replaceGroupAsyncWithHttpInfo()

Operation replaceGroupAsyncWithHttpInfo


    public
                    replaceGroupAsyncWithHttpInfo(string $slug, string $group_id, ScimGroupResource $scim_group_resource[, string $contentType = self::contentTypes['replaceGroup'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$group_id : string: (required)
$scim_group_resource : ScimGroupResource: (required)
$contentType : string = self::contentTypes['replaceGroup'][0]: The value for the Content-Type header. Check self::contentTypes['replaceGroup'] to see the possible values for this operation

Return values

PromiseInterface —

replaceGroupRequest()

Create request for operation 'replaceGroup'


    public
                    replaceGroupRequest(string $slug, string $group_id, ScimGroupResource $scim_group_resource[, string $contentType = self::contentTypes['replaceGroup'][0] ]) : Request

Parameters

$slug : string: (required)
$group_id : string: (required)
$scim_group_resource : ScimGroupResource: (required)
$contentType : string = self::contentTypes['replaceGroup'][0]: The value for the Content-Type header. Check self::contentTypes['replaceGroup'] to see the possible values for this operation

Return values

Request —

replaceGroupWithHttpInfo()

Operation replaceGroupWithHttpInfo


    public
                    replaceGroupWithHttpInfo(string $slug, string $group_id, ScimGroupResource $scim_group_resource[, string $contentType = self::contentTypes['replaceGroup'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$group_id : string: (required)
$scim_group_resource : ScimGroupResource: (required)
$contentType : string = self::contentTypes['replaceGroup'][0]: The value for the Content-Type header. Check self::contentTypes['replaceGroup'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

replaceUser()

Operation replaceUser


    public
                    replaceUser(string $slug, string $user_id, ScimUserResource $scim_user_resource[, string $contentType = self::contentTypes['replaceUser'][0] ]) : object

Parameters

$slug : string: slug (required)
$user_id : string: user_id (required)
$scim_user_resource : ScimUserResource: scim_user_resource (required)
$contentType : string = self::contentTypes['replaceUser'][0]: The value for the Content-Type header. Check self::contentTypes['replaceUser'] to see the possible values for this operation

Return values

object —

replaceUserAsync()

Operation replaceUserAsync


    public
                    replaceUserAsync(string $slug, string $user_id, ScimUserResource $scim_user_resource[, string $contentType = self::contentTypes['replaceUser'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$user_id : string: (required)
$scim_user_resource : ScimUserResource: (required)
$contentType : string = self::contentTypes['replaceUser'][0]: The value for the Content-Type header. Check self::contentTypes['replaceUser'] to see the possible values for this operation

Return values

PromiseInterface —

replaceUserAsyncWithHttpInfo()

Operation replaceUserAsyncWithHttpInfo


    public
                    replaceUserAsyncWithHttpInfo(string $slug, string $user_id, ScimUserResource $scim_user_resource[, string $contentType = self::contentTypes['replaceUser'][0] ]) : PromiseInterface

Parameters

$slug : string: (required)
$user_id : string: (required)
$scim_user_resource : ScimUserResource: (required)
$contentType : string = self::contentTypes['replaceUser'][0]: The value for the Content-Type header. Check self::contentTypes['replaceUser'] to see the possible values for this operation

Return values

PromiseInterface —

replaceUserRequest()

Create request for operation 'replaceUser'


    public
                    replaceUserRequest(string $slug, string $user_id, ScimUserResource $scim_user_resource[, string $contentType = self::contentTypes['replaceUser'][0] ]) : Request

Parameters

$slug : string: (required)
$user_id : string: (required)
$scim_user_resource : ScimUserResource: (required)
$contentType : string = self::contentTypes['replaceUser'][0]: The value for the Content-Type header. Check self::contentTypes['replaceUser'] to see the possible values for this operation

Return values

Request —

replaceUserWithHttpInfo()

Operation replaceUserWithHttpInfo


    public
                    replaceUserWithHttpInfo(string $slug, string $user_id, ScimUserResource $scim_user_resource[, string $contentType = self::contentTypes['replaceUser'][0] ]) : array<string|int, mixed>

Parameters

$slug : string: (required)
$user_id : string: (required)
$scim_user_resource : ScimUserResource: (required)
$contentType : string = self::contentTypes['replaceUser'][0]: The value for the Content-Type header. Check self::contentTypes['replaceUser'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

Return values

void —

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

SCIMApi in package MailSlurp

Tags

Table of Contents

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

Return values

createGroup()

Parameters

Tags

Return values

createGroupAsync()

Parameters

Tags

Return values

createGroupAsyncWithHttpInfo()

Parameters

Tags

Return values

createGroupRequest()

Parameters

Tags

Return values

createGroupWithHttpInfo()

Parameters

Tags

Return values

createUser()

Parameters

Tags

Return values

createUserAsync()

Parameters

Tags

Return values

createUserAsyncWithHttpInfo()

Parameters

Tags

Return values

createUserRequest()

Parameters

Tags

Return values

createUserWithHttpInfo()

Parameters

Tags

Return values

deleteGroup()

Parameters

Tags

Return values

deleteGroupAsync()

Parameters

Tags

Return values

deleteGroupAsyncWithHttpInfo()

Parameters

Tags

Return values

deleteGroupRequest()

Parameters

Tags

Return values

deleteGroupWithHttpInfo()

Parameters

Tags

Return values

deleteUser()

Parameters

Tags

Return values

deleteUserAsync()

Parameters

SCIMApi
in package

MailSlurp