Connections
extends ManagementEndpoint
in package
implements
ConnectionsInterface
Class Connections.
Handles requests to the Connections endpoint of the v2 Management API.
Tags
Interfaces, Classes, Traits and Enums
- ConnectionsInterface
- Interface ConnectionsInterface.
Table of Contents
- $httpClient : HttpClient
- __construct() : mixed
- ManagementEndpoint constructor.
- create() : ResponseInterface
- Create a new Connection.
- delete() : ResponseInterface
- Delete a Connection.
- deleteUser() : ResponseInterface
- Delete a specific User for a Connection.
- get() : ResponseInterface
- Get a single Connection.
- getAll() : ResponseInterface
- Get connection(s).
- 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
- update() : ResponseInterface
- Update a Connection.
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 —create()
Create a new Connection.
public
create(string $name, string $strategy[, array<string|int, mixed>|null $body = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: create:connections.
Parameters
- $name : string
-
the name of the new connection
- $strategy : string
-
the identity provider identifier for the new connection
- $body : array<string|int, mixed>|null = null
-
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 —delete()
Delete a Connection.
public
delete(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: delete:connections.
Parameters
- $id : string
-
connection (by it's ID) to delete
- $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 —deleteUser()
Delete a specific User for a Connection.
public
deleteUser(string $id, string $email[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: delete:users.
Parameters
- $id : string
-
Connection (by it's ID)
- $email : string
-
email of the user to delete
- $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()
Get a single Connection.
public
get(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:connections.
Parameters
- $id : string
-
connection (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 —getAll()
Get connection(s).
public
getAll([array<string|int, mixed>|null $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:connections.
Parameters
- $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 —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
Return values
static —update()
Update a Connection.
public
update(string $id[, array<string|int, mixed>|null $body = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:connections.
Parameters
- $id : string
-
connection (by it's ID) to update
- $body : array<string|int, mixed>|null = null
-
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.)