Skip to content

Latest commit

 

History

History
265 lines (177 loc) · 14.9 KB

README.md

File metadata and controls

265 lines (177 loc) · 14.9 KB

SamlConnections

(samlConnections)

Overview

Available Operations

  • create - Create a SAML Connection
  • delete - Delete a SAML Connection
  • get - Retrieve a SAML Connection by ID
  • list - Get a list of SAML Connections for an instance
  • update - Update a SAML Connection

create

Create a new SAML Connection.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;
use Clerk\Backend\Models\Operations;

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Operations\CreateSAMLConnectionRequestBody(
    name: '<value>',
    domain: 'low-packaging.info',
    provider: Operations\Provider::SamlCustom,
);

$response = $sdk->samlConnections->create(
    request: $request
);

if ($response->schemasSAMLConnection !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\CreateSAMLConnectionRequestBody ✔️ The request object to use for the request.

Response

?Operations\CreateSAMLConnectionResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors 402, 403, 404, 422 application/json
Errors\SDKException 4XX, 5XX */*

delete

Deletes the SAML Connection whose ID matches the provided id in the path.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->samlConnections->delete(
    samlConnectionId: '<id>'
);

if ($response->deletedObject !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
samlConnectionId string ✔️ The ID of the SAML Connection to delete

Response

?Operations\DeleteSAMLConnectionResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors 402, 403, 404 application/json
Errors\SDKException 4XX, 5XX */*

get

Fetches the SAML Connection whose ID matches the provided saml_connection_id in the path.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->samlConnections->get(
    samlConnectionId: '<id>'
);

if ($response->schemasSAMLConnection !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
samlConnectionId string ✔️ The ID of the SAML Connection

Response

?Operations\GetSAMLConnectionResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors 402, 403, 404 application/json
Errors\SDKException 4XX, 5XX */*

list

Returns the list of SAML Connections for an instance. Results can be paginated using the optional limit and offset query parameters. The SAML Connections are ordered by descending creation date and the most recent will be returned first.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->samlConnections->list(
    limit: 10,
    offset: 0,
    organizationId: [
        '<id>',
    ]

);

if ($response->samlConnections !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
limit ?int ➖ Applies a limit to the number of results returned.
Can be used for paginating the results together with offset.
offset ?int ➖ Skip the first offset results when paginating.
Needs to be an integer greater or equal to zero.
To be used in conjunction with limit.
organizationId array<string> ➖ Returns SAML connections that have an associated organization ID to the
given organizations.
For each organization id, the + and - can be
prepended to the id, which denote whether the
respective organization should be included or
excluded from the result set.
Accepts up to 100 organization ids.

Response

?Operations\ListSAMLConnectionsResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors 402, 403, 422 application/json
Errors\SDKException 4XX, 5XX */*

update

Updates the SAML Connection whose ID matches the provided id in the path.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;
use Clerk\Backend\Models\Operations;

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$requestBody = new Operations\UpdateSAMLConnectionRequestBody();

$response = $sdk->samlConnections->update(
    samlConnectionId: '<id>',
    requestBody: $requestBody

);

if ($response->schemasSAMLConnection !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
samlConnectionId string ✔️ The ID of the SAML Connection to update
requestBody Operations\UpdateSAMLConnectionRequestBody ✔️ N/A

Response

?Operations\UpdateSAMLConnectionResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors 402, 403, 404, 422 application/json
Errors\SDKException 4XX, 5XX */*