Iam
Sso
Sso endpoint reference.
List
Lists all SSO connectors configured for the account.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. |
php
$response = $client->iam()->sso()->list('ACCOUNT_ID');
Create
Creates a new SSO connector for logging into Cloudflare through an identity provider.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
values | array | Yes | SSO Connector values, requires email_domain. |
php
$response = $client->iam()->sso()->create('ACCOUNT_ID', []);
Get
Get information about a specific SSO connector.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
ssoConnectorId | string | Yes | SSO Connector identifier. |
php
$response = $client->iam()->sso()->get('ACCOUNT_ID', 'SSO_CONNECTOR_ID');
Update
Updates the state or configuration of an SSO connector.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
ssoConnectorId | string | Yes | SSO Connector identifier. | |
values | array | No | [] | SSO Connector values, e.g. enabled, use_fedramp_language. |
php
$response = $client->iam()->sso()->update('ACCOUNT_ID', 'SSO_CONNECTOR_ID', []);
Delete
Deletes an SSO connector.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
ssoConnectorId | string | Yes | SSO Connector identifier. |
php
$response = $client->iam()->sso()->delete('ACCOUNT_ID', 'SSO_CONNECTOR_ID');
Begin Verification
Begin the verification process for an SSO connector.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
ssoConnectorId | string | Yes | SSO Connector identifier. |
php
$response = $client->iam()->sso()->beginVerification('ACCOUNT_ID', 'SSO_CONNECTOR_ID');