Contact UsGet started
© 2024 Iron Hive LLC Belgrade

SAML Federation API, REST: Certificate.List

Written by
Updated at November 7, 2024

Retrieves the list of certificates in the specified federation.

HTTP request

GET https://organization-manager.api.cloud.yandex.net/organization-manager/v1/saml/certificates

Query parameters

Field

Description

federationId

string

Required field. ID of the federation to list certificates in.
To get the federation ID make a yandex.cloud.organizationmanager.v1.saml.FederationService.List request.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListCertificatesResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken
to the ListCertificatesResponse.nextPageToken
returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The field name. Currently you can use filtering only on Certificate.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

Response

HTTP Code: 200 - OK

{
  "certificates": [
    {
      "id": "string",
      "federationId": "string",
      "name": "string",
      "description": "string",
      "createdAt": "string",
      "data": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

certificates[]

Certificate

List of certificates.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListCertificatesRequest.pageSize, use
the nextPageToken as the value
for the ListCertificatesRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

Certificate

A certificate.

Field

Description

id

string

Required field. ID of the certificate.

federationId

string

Required field. ID of the federation that the certificate belongs to.

name

string

Name of the certificate.

description

string

Description of the certificate.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

data

string

Required field. Certificate data in PEM format.
Previous
Get
Next
Create