SAML users

Information about SAML users

Describe a SAML user within an account

get/saml-user/{id}

Describe a SAML user within an account.

SecurityCloudOneApiKey
Request
path Parameters
id
required
string

The SAML user's hashed identity.

Example: d9ce107844a0f255e38a43b787de2d3a7ac27315fb4985d52e2bbdf8e8d00d1a
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The response body contains the SAML user details.

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
{
  • "subject": "user.one@example.com",
  • "urn": "urn:cloudone:identity:us-1:012345678901:saml-user/d9ce107844a0f255e38a43b787de2d3a7ac27315fb4985d52e2bbdf8e8d00d1a",
  • "roleID": "full-access",
  • "created": "2020-04-01T00:00:00Z",
  • "lastModified": "2020-04-01T00:00:00Z"
}

List SAML users

get/saml-users

List SAML users.

Security
Request
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 users.

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
{
  • "users": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}
➔ Next to SAML identity providers