Jobs
extends ManagementEndpoint
in package
implements
JobsInterface
Class Jobs.
Handles requests to the Jobs endpoint of the v2 Management API.
Tags
Interfaces, Classes, Traits and Enums
- JobsInterface
- Interface JobsInterface.
Table of Contents
- $httpClient : HttpClient
- __construct() : mixed
- ManagementEndpoint constructor.
- createExportUsers() : ResponseInterface
- Export all users to a file via a long-running job.
- createImportUsers() : ResponseInterface
- Import users from a formatted file into a connection via a long-running job.
- createSendVerificationEmail() : ResponseInterface
- Create a verification email job.
- get() : ResponseInterface
- Retrieves a job. Useful to check its status.
- getErrors() : ResponseInterface
- Retrieve error details of a failed job.
- getHttpClient() : HttpClient
- Get the injected HttpClient instance.
- getLastRequest() : HttpRequest|null
- Return an instance of HttpRequest representing the last issued request.
- getResponsePaginator() : HttpResponsePaginator
- Return a ResponsePaginator instance configured for the last HttpRequest.
- instance() : static
Properties
$httpClient
private
HttpClient
$httpClient
Methods
__construct()
ManagementEndpoint constructor.
public
final __construct(HttpClient $httpClient) : mixed
Parameters
- $httpClient : HttpClient
-
httpClient instance to use
Return values
mixed —createExportUsers()
Export all users to a file via a long-running job.
public
createExportUsers(array<string|int, mixed> $body[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:users.
Parameters
- $body : array<string|int, mixed>
-
Body content to pass with the API request. See @see for supported options.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —createImportUsers()
Import users from a formatted file into a connection via a long-running job.
public
createImportUsers(string $filePath, string $connectionId[, array<string|int, mixed>|null $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scopes:
-
create:users -
read:users.
Parameters
- $filePath : string
-
path to formatted file to import
- $connectionId : string
-
id of the Connection to use
- $parameters : array<string|int, mixed>|null = null
-
Optional.Additional query parameters to pass with the API request. See @see for supported options.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —createSendVerificationEmail()
Create a verification email job.
public
createSendVerificationEmail(string $userId[, array<string|int, mixed>|null $body = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:users.
Parameters
- $userId : string
-
user ID of the user to send the verification email to
- $body : array<string|int, mixed>|null = null
-
Optional. Additional body content to pass with the API request. See @see for supported options.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —get()
Retrieves a job. Useful to check its status.
public
get(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scopes:
-
create:users -
read:users.
Parameters
- $id : string
-
job (by it's ID) to query
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —getErrors()
Retrieve error details of a failed job.
public
getErrors(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scopes:
-
create:users -
read:users.
Parameters
- $id : string
-
job (by it's ID) to query
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —getHttpClient()
Get the injected HttpClient instance.
public
final getHttpClient() : HttpClient
Return values
HttpClient —getLastRequest()
Return an instance of HttpRequest representing the last issued request.
public
final getLastRequest() : HttpRequest|null
Return values
HttpRequest|null —getResponsePaginator()
Return a ResponsePaginator instance configured for the last HttpRequest.
public
final getResponsePaginator() : HttpResponsePaginator
Return values
HttpResponsePaginator —instance()
public
static instance(HttpClient $httpClient) : static
Parameters
- $httpClient : HttpClient