SAML Application API, REST: Application.List
Retrieves the list of SAML applications in the specified organization.
HTTP request
GET https://organization-manager.api.cloud.yandex.net/organization-manager/v1/idp/application/saml/applications
Query parameters
Request to list SAML applications in an organization.
|
Field |
Description |
|
organizationId |
string Required field. ID of the organization to list applications in. The maximum string length in characters is 50. |
|
pageSize |
string (int64) The maximum number of results per page to return. Acceptable values are 0 to 1000, inclusive. |
|
pageToken |
string Page token for pagination. The maximum string length in characters is 2000. |
|
filter |
string A filter expression that filters resources listed in the response. The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"applications": [
{
"id": "string",
"organizationId": "string",
"name": "string",
"description": "string",
"status": "string",
"labels": "object",
"createdAt": "string",
"updatedAt": "string",
"serviceProvider": {
"entityId": "string",
"acsUrls": [
{
"url": "string",
"index": "string"
}
],
"sloUrls": [
{
"url": "string",
"responseUrl": "string",
"protocolBinding": "string"
}
]
},
"securitySettings": {
"signatureMode": "string",
"signatureCertificateId": "string"
},
"attributeMapping": {
"nameId": {
"format": "string",
"value": "string"
},
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"groupClaimsSettings": {
"groupDistributionType": "string",
"groupAttributeName": "string"
},
"identityProviderMetadata": {
"issuer": "string",
"ssoUrl": "string",
"metadataUrl": "string",
"sloUrl": "string"
}
}
],
"nextPageToken": "string"
}
Response message for ApplicationService.List.
|
Field |
Description |
|
applications[] |
List of SAML applications. |
|
nextPageToken |
string Token for getting the next page of the list. |
Application
A SAML application resource.
|
Field |
Description |
|
id |
string Unique identifier of the SAML application. |
|
organizationId |
string ID of the organization that the application belongs to. |
|
name |
string Name of the SAML application. |
|
description |
string Description of the SAML application. |
|
status |
enum (Status) Current status of the SAML application.
|
|
labels |
object (map<string, string>) Resource labels as |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Modification timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
serviceProvider |
Service provider configuration for the SAML application. |
|
securitySettings |
Security settings for the SAML application. |
|
attributeMapping |
Attribute mapping configuration for the SAML application. |
|
groupClaimsSettings |
Group claims settings for the SAML application. |
|
identityProviderMetadata |
Identity provider metadata for the SAML application. |
ServiceProvider
Service provider configuration for SAML applications.
|
Field |
Description |
|
entityId |
string Required field. Service provider entity ID. The maximum string length in characters is 8000. |
|
acsUrls[] |
Assertion Consumer Service URLs. The number of elements must be in the range 1-100. |
|
sloUrls[] |
Single Logout Service URLs. The number of elements must be in the range 0-100. |
AssertionConsumerServiceURL
Assertion Consumer Service URL configuration.
|
Field |
Description |
|
url |
string Required field. The URL where SAML responses are sent. The maximum string length in characters is 8000. |
|
index |
string (int64) Optional index for the assertion consumer service. |
SingleLogoutServiceURL
Single Logout Service URL configuration.
|
Field |
Description |
|
url |
string Required field. The URL where logout requests are sent. The maximum string length in characters is 8000. |
|
responseUrl |
string Optional separate URL for logout responses. The maximum string length in characters is 8000. |
|
protocolBinding |
enum (ProtocolBinding) Required field. Protocol binding supported by the logout endpoint.
|
SecuritySettings
Security settings for SAML applications.
|
Field |
Description |
|
signatureMode |
enum (SignatureMode) Signature mode for SAML messages.
|
|
signatureCertificateId |
string ID of the signature certificate to use. |
AttributeMapping
Attribute mapping configuration for SAML applications.
|
Field |
Description |
|
nameId |
Required field. NameID configuration for the SAML application. |
|
attributes[] |
List of attribute mappings. The maximum number of elements is 50. |
NameId
NameID configuration for SAML applications.
|
Field |
Description |
|
format |
enum (Format) Required field. Format of the NameID.
|
|
value |
string Required field. Value of the NameID. |
Attribute
Attribute mapping for SAML applications.
|
Field |
Description |
|
name |
string Required field. Name of the SAML attribute. The maximum string length in characters is 8000. |
|
value |
string Required field. Value of the SAML attribute. The maximum string length in characters is 50. |
GroupClaimsSettings
Group claims settings for SAML applications.
|
Field |
Description |
|
groupDistributionType |
enum (GroupDistributionType) Distribution type for group claims.
|
|
groupAttributeName |
string Name of the SAML attribute that contains group information. The maximum string length in characters is 8000. |
IdentityProviderMetadata
Identity provider metadata for SAML applications.
|
Field |
Description |
|
issuer |
string Identity provider issuer identifier. |
|
ssoUrl |
string Identity provider Single Sign-On URL. |
|
metadataUrl |
string Identity provider metadata URL. |
|
sloUrl |
string Identity provider Single Logout URL. |