SAML Application API, gRPC: ApplicationService.List
Retrieves the list of SAML applications in the specified organization.
gRPC request
rpc List (ListApplicationsRequest) returns (ListApplicationsResponse)
ListApplicationsRequest
{
"organization_id": "string",
"page_size": "int64",
"page_token": "string",
"filter": "string"
}
Request to list SAML applications in an organization.
|
Field |
Description |
|
organization_id |
string Required field. ID of the organization to list applications in. |
|
page_size |
int64 The maximum number of results per page to return. |
|
page_token |
string Page token for pagination. |
|
filter |
string A filter expression that filters resources listed in the response. |
ListApplicationsResponse
{
"applications": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"description": "string",
"status": "Status",
"labels": "map<string, string>",
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
"service_provider": {
"entity_id": "string",
"acs_urls": [
{
"url": "string",
"index": "google.protobuf.Int64Value"
}
],
"slo_urls": [
{
"url": "string",
"response_url": "string",
"protocol_binding": "ProtocolBinding"
}
]
},
"security_settings": {
"signature_mode": "SignatureMode",
"signature_certificate_id": "string"
},
"attribute_mapping": {
"name_id": {
"format": "Format",
"value": "string"
},
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"group_claims_settings": {
"group_distribution_type": "GroupDistributionType",
"group_attribute_name": "string"
},
"identity_provider_metadata": {
"issuer": "string",
"sso_url": "string",
"metadata_url": "string",
"slo_url": "string"
}
}
],
"next_page_token": "string"
}
Response message for ApplicationService.List.
|
Field |
Description |
|
applications[] |
List of SAML applications. |
|
next_page_token |
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. |
|
organization_id |
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 |
|
created_at |
Creation timestamp. |
|
updated_at |
Modification timestamp. |
|
service_provider |
Service provider configuration for the SAML application. |
|
security_settings |
Security settings for the SAML application. |
|
attribute_mapping |
Attribute mapping configuration for the SAML application. |
|
group_claims_settings |
Group claims settings for the SAML application. |
|
identity_provider_metadata |
Identity provider metadata for the SAML application. |
ServiceProvider
Service provider configuration for SAML applications.
|
Field |
Description |
|
entity_id |
string Required field. Service provider entity ID. |
|
acs_urls[] |
Assertion Consumer Service URLs. |
|
slo_urls[] |
Single Logout Service URLs. |
AssertionConsumerServiceURL
Assertion Consumer Service URL configuration.
|
Field |
Description |
|
url |
string Required field. The URL where SAML responses are sent. |
|
index |
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. |
|
response_url |
string Optional separate URL for logout responses. |
|
protocol_binding |
enum ProtocolBinding Required field. Protocol binding supported by the logout endpoint.
|
SecuritySettings
Security settings for SAML applications.
|
Field |
Description |
|
signature_mode |
enum SignatureMode Signature mode for SAML messages.
|
|
signature_certificate_id |
string ID of the signature certificate to use. |
AttributeMapping
Attribute mapping configuration for SAML applications.
|
Field |
Description |
|
name_id |
Required field. NameID configuration for the SAML application. |
|
attributes[] |
List of attribute mappings. |
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. |
|
value |
string Required field. Value of the SAML attribute. |
GroupClaimsSettings
Group claims settings for SAML applications.
|
Field |
Description |
|
group_distribution_type |
enum GroupDistributionType Distribution type for group claims.
|
|
group_attribute_name |
string Name of the SAML attribute that contains group information. |
IdentityProviderMetadata
Identity provider metadata for SAML applications.
|
Field |
Description |
|
issuer |
string Identity provider issuer identifier. |
|
sso_url |
string Identity provider Single Sign-On URL. |
|
metadata_url |
string Identity provider metadata URL. |
|
slo_url |
string Identity provider Single Logout URL. |