IdentityProviders
extends CloudApiBase
in
implements
CloudApiInterface
Class IdentityProviders
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| getAll() | Returns a list of identity providers for the user. | IdentityProvidersResponse |
| get() | Returns a specific identity provider by UUID. | IdentityProviderResponse |
| delete() | Delete a specific identity provider by UUID. | OperationResponse |
| disable() | Disables an identity provider by UUID. | OperationResponse |
| enable() | Enables an identity provider by UUID. | OperationResponse |
| update() | Updates a identity provider by UUID. | OperationResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
getAll()
Returns a list of identity providers for the user.
public
getAll(
)
: IdentityProvidersResponse
Return values
IdentityProvidersResponseget()
Returns a specific identity provider by UUID.
public
get(
$idpUuid :
string
)
: IdentityProviderResponse
Parameters
- $idpUuid : string
The identity provider ID
Return values
IdentityProviderResponsedelete()
Delete a specific identity provider by UUID.
public
delete(
$idpUuid :
string
)
: OperationResponse
Parameters
- $idpUuid : string
Return values
OperationResponsedisable()
Disables an identity provider by UUID.
public
disable(
$idpUuid :
string
)
: OperationResponse
Parameters
- $idpUuid : string
Return values
OperationResponseenable()
Enables an identity provider by UUID.
public
enable(
$idpUuid :
string
)
: OperationResponse
Parameters
- $idpUuid : string
Return values
OperationResponseupdate()
Updates a identity provider by UUID.
public
update(
$idpUuid :
string
, $label :
string
, $entityId :
string
, $ssoUrl :
string
, $certificate :
string
)
: OperationResponse
Parameters
- $idpUuid : string
- $label : string
- $entityId : string
- $ssoUrl : string
- $certificate : string
Return values
OperationResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface