SAML identity providers

List SAML identity providers

get/identity-providers

List SAML identity providers.

Request
Security:
query Parameters
cursor
string <byte>
Default: ""

An encoded value used to retrieve the next set of results for a query that returns more than limit results.

limit
integer <int64>
Default: 25

The maximum number of records to return.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

List of SAML identity providers.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Response samples
application/json
{
  • "identity-providers": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}

Create SAML identity provider

post/identity-providers

Create a SAML identity provider.

Request
Security:
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Request Body schema: application/json
created
string <date-time>

The time that the identity provider was created.

description
string

An optional description for this SAML identity provider.

entityID
string

The entity ID extracted from the identity provider's metadata XML.

object

A mapping defining which attributes to use when processing the SAML response.

metadataURL
string

The URL through which the metadata XML can be retrieved. The request body need contain only metadataURL or metadataXML; it cannot contain both; they are mutually exclusive.

metadataXML
string <byte>

The metadata XML describing this SAML identity provider.

name
string

The name to display for this SAML identity provider.

updated
string <date-time>

The time that the identity provider was last updated.

urn
string

The fully-qualified identifier for this SAML identity provider.

validUntil
string <date-time>

The latest expiry date from the certificates in the identity provider's metadata XML.

Responses
201

The identity provider has been created.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Request samples
application/json
{
  • "name": "ADFS",
  • "mapping": {
    },
  • "metadataXML": "PD94bWwuLi4K"
}
Response samples
application/json
{
  • "name": "IdentityProvider",
  • "description": "An example identity provider.",
  • "mapping": {
    },
  • "urn": "urn:cloudone:identity:us-1:012345678901:identity-providers/saml/0ujsswThIGTUYm2K8FjOOfXtY1K",
  • "validUntil": "2021-04-01T00:00:00Z",
  • "created": "2020-04-01T00:00:00Z",
  • "updated": "2020-04-01T00:00:00Z"
}

Describe SAML identity provider

get/identity-providers/{id}

Describe a SAML identity provider.

Request
Security:
path Parameters
id
required
string

The SAML identity provider ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The details of the SAML identity provider.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

404

The resource you were looking for doesn't exist.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Response samples
application/json
{
  • "name": "IdentityProvider",
  • "description": "An example identity provider.",
  • "mapping": {
    },
  • "urn": "urn:cloudone:identity:us-1:012345678901:identity-providers/saml/0ujsswThIGTUYm2K8FjOOfXtY1K",
  • "validUntil": "2021-04-01T00:00:00Z",
  • "created": "2020-04-01T00:00:00Z",
  • "updated": "2020-04-01T00:00:00Z"
}

Modify SAML identity provider

post/identity-providers/{id}

Modify a SAML identity provider.

Request
Security:
path Parameters
id
required
string

The SAML identity provider ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Request Body schema: application/json
created
string <date-time>

The time that the identity provider was created.

description
string

An optional description for this SAML identity provider.

entityID
string

The entity ID extracted from the identity provider's metadata XML.

object

A mapping defining which attributes to use when processing the SAML response.

metadataURL
string

The URL through which the metadata XML can be retrieved. The request body need contain only metadataURL or metadataXML; it cannot contain both; they are mutually exclusive.

metadataXML
string <byte>

The metadata XML describing this SAML identity provider.

name
string

The name to display for this SAML identity provider.

updated
string <date-time>

The time that the identity provider was last updated.

urn
string

The fully-qualified identifier for this SAML identity provider.

validUntil
string <date-time>

The latest expiry date from the certificates in the identity provider's metadata XML.

Responses
200

The SAML identity provider has been modified.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

404

The resource you were looking for doesn't exist.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Request samples
application/json
{
  • "name": "ADFS",
  • "mapping": {
    },
  • "metadataXML": "PD94bWwuLi4K"
}
Response samples
application/json
{
  • "name": "IdentityProvider",
  • "description": "An example identity provider.",
  • "mapping": {
    },
  • "urn": "urn:cloudone:identity:us-1:012345678901:identity-providers/saml/0ujsswThIGTUYm2K8FjOOfXtY1K",
  • "validUntil": "2021-04-01T00:00:00Z",
  • "created": "2020-04-01T00:00:00Z",
  • "updated": "2020-04-01T00:00:00Z"
}

Delete SAML identity provider

delete/identity-providers/{id}

Delete a SAML identity provider.

Request
Security:
path Parameters
id
required
string

The SAML identity provider ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
204

The SAML identity provider has been deleted.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Response samples
application/json
{
  • "message": "Something went wrong."
}