Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/content/2.client/21.iam/00.index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Iam
description: "Identity and Access Management."
navigation:
title: Iam
---

Identity and Access Management.

## Related

- [Permission Groups](/client/iam/permission-groups)
- [Resource Groups](/client/iam/resource-groups)
- [Sso](/client/iam/sso)
- [Oauth Clients](/client/iam/oauth-clients)
- [Oauth Scopes](/client/iam/oauth-scopes)
- [User Groups](/client/iam/user-groups)

60 changes: 60 additions & 0 deletions docs/content/2.client/21.iam/01.permission-groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: Permission Groups
description: "Permission Groups endpoint reference."
navigation:
title: Permission Groups
---

## List

List all the permissions groups for an account.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "params"
type: "array"
required: false
description: "Array containing the necessary params, e.g. id, name, label."
default: "[]"
---
::

```php [php]
$response = $client->iam()->permissionGroups()->list('ACCOUNT_ID', []);
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/account-permission-group-list"}
View this operation on the Cloudflare API Reference
::

## Get

Get information about a specific permission group in an account.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "permissionGroupId"
type: "string"
required: true
description: "Permission Group identifier."
---
::

```php [php]
$response = $client->iam()->permissionGroups()->get('ACCOUNT_ID', 'PERMISSION_GROUP_ID');
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/account-permission-group-details"}
View this operation on the Cloudflare API Reference
::

143 changes: 143 additions & 0 deletions docs/content/2.client/21.iam/02.resource-groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
---
title: Resource Groups
description: "Resource Groups endpoint reference."
navigation:
title: Resource Groups
---

## List

List all the resource groups for an account.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "params"
type: "array"
required: false
description: "Array containing the necessary params, e.g. id, name."
default: "[]"
---
::

```php [php]
$response = $client->iam()->resourceGroups()->list('ACCOUNT_ID', []);
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/account-resource-group-list"}
View this operation on the Cloudflare API Reference
::

## Create

Create a new Resource Group under the specified account.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "values"
type: "array"
required: true
description: "Resource Group values, requires name and scope."
---
::

```php [php]
$response = $client->iam()->resourceGroups()->create('ACCOUNT_ID', []);
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/account-resource-group-create"}
View this operation on the Cloudflare API Reference
::

## Get

Get information about a specific resource group in an account.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "resourceGroupId"
type: "string"
required: true
description: "Resource Group identifier."
---
::

```php [php]
$response = $client->iam()->resourceGroups()->get('ACCOUNT_ID', 'RESOURCE_GROUP_ID');
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/account-resource-group-details"}
View this operation on the Cloudflare API Reference
::

## Update

Modify an existing resource group.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "resourceGroupId"
type: "string"
required: true
description: "Resource Group identifier."
- name: "values"
type: "array"
required: false
description: "Resource Group values, e.g. name, scope."
default: "[]"
---
::

```php [php]
$response = $client->iam()->resourceGroups()->update('ACCOUNT_ID', 'RESOURCE_GROUP_ID', []);
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/account-resource-group-update"}
View this operation on the Cloudflare API Reference
::

## Delete

Remove a resource group from an account.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "resourceGroupId"
type: "string"
required: true
description: "Resource Group identifier."
---
::

```php [php]
$response = $client->iam()->resourceGroups()->delete('ACCOUNT_ID', 'RESOURCE_GROUP_ID');
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/account-resource-group-delete"}
View this operation on the Cloudflare API Reference
::

164 changes: 164 additions & 0 deletions docs/content/2.client/21.iam/03.sso.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
---
title: Sso
description: "Sso endpoint reference."
navigation:
title: Sso
---

## List

Lists all SSO connectors configured for the account.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
---
::

```php [php]
$response = $client->iam()->sso()->list('ACCOUNT_ID');
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/get-all-sso-connectors"}
View this operation on the Cloudflare API Reference
::

## Create

Creates a new SSO connector for logging into Cloudflare through an identity provider.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "values"
type: "array"
required: true
description: "SSO Connector values, requires email_domain."
---
::

```php [php]
$response = $client->iam()->sso()->create('ACCOUNT_ID', []);
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/init-new-sso-connector"}
View this operation on the Cloudflare API Reference
::

## Get

Get information about a specific SSO connector.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "ssoConnectorId"
type: "string"
required: true
description: "SSO Connector identifier."
---
::

```php [php]
$response = $client->iam()->sso()->get('ACCOUNT_ID', 'SSO_CONNECTOR_ID');
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/get-sso-connector"}
View this operation on the Cloudflare API Reference
::

## Update

Updates the state or configuration of an SSO connector.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "ssoConnectorId"
type: "string"
required: true
description: "SSO Connector identifier."
- name: "values"
type: "array"
required: false
description: "SSO Connector values, e.g. enabled, use_fedramp_language."
default: "[]"
---
::

```php [php]
$response = $client->iam()->sso()->update('ACCOUNT_ID', 'SSO_CONNECTOR_ID', []);
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/update-sso-connector-state"}
View this operation on the Cloudflare API Reference
::

## Delete

Deletes an SSO connector.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "ssoConnectorId"
type: "string"
required: true
description: "SSO Connector identifier."
---
::

```php [php]
$response = $client->iam()->sso()->delete('ACCOUNT_ID', 'SSO_CONNECTOR_ID');
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/delete-sso-connector"}
View this operation on the Cloudflare API Reference
::

## Begin Verification

Begin the verification process for an SSO connector.

::params-table
---
params:
- name: "accountId"
type: "string"
required: true
description: "Account identifier."
- name: "ssoConnectorId"
type: "string"
required: true
description: "SSO Connector identifier."
---
::

```php [php]
$response = $client->iam()->sso()->beginVerification('ACCOUNT_ID', 'SSO_CONNECTOR_ID');
```

::callout{icon="i-simple-icons-cloudflare" to="https://developers.cloudflare.com/api/operations/begin-sso-connector-verification"}
View this operation on the Cloudflare API Reference
::

Loading
Loading