Identity and Access Management SAML API, REST: Federation methods
A set of methods for managing federations.
JSON Representation
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"createdAt": "string",
"cookieMaxAge": "string",
"autoCreateAccountOnLogin": true,
"issuer": "string",
"ssoBinding": "string",
"ssoUrl": "string",
"securitySettings": {
"encryptedAssertions": true
},
"caseInsensitiveNameIds": true
}
| Field | Description |
|---|---|
| id | string Required. ID of the federation. The maximum string length in characters is 50. |
| folderId | string Required. ID of the folder that the federation belongs to. The maximum string length in characters is 50. |
| name | string Required. Name of the federation. Value must match the regular expression |
| description | string Description of the federation. The maximum string length in characters is 256. |
| 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
| cookieMaxAge | string Browser cookie lifetime in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. Acceptable values are 600 seconds to 43200 seconds, inclusive. |
| autoCreateAccountOnLogin | boolean (boolean) Add new users automatically on successful authentication. The user will get the If the value is |
| issuer | string Required. ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates. The maximum string length in characters is 8000. |
| ssoBinding | string Single sign-on endpoint binding type. Most Identity Providers support the SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
|
| ssoUrl | string Required. Single sign-on endpoint URL. Specify the link to the IdP login page here. The maximum string length in characters is 8000. |
| securitySettings | object Federation security settings. Federation security settings. |
| securitySettings. encryptedAssertions |
boolean (boolean) Enable encrypted assertions. |
| caseInsensitiveNameIds | boolean (boolean) Use case insensitive Name IDs. |
Methods
| Method | Description |
|---|---|
| addUserAccounts | Adds users to the specified federation. |
| create | Creates a federation in the specified folder. |
| delete | Deletes the specified federation. |
| get | Returns the specified federation. |
| list | Retrieves the list of federations in the specified folder. |
| listOperations | Lists operations for the specified federation. |
| listUserAccounts | Lists users for the specified federation. |
| update | Updates the specified federation. |