saml:authservice : SAML authentication service object.

This object represents SAML authentication service.

Object Reference

References to saml:authservice are object references. The name part of the SAML authentication service object reference has the following components:

  • The name of the SAML authentication service object.

Example: saml:authservice/ZG5zLm5ldHdvcmtfdmlldyQxMTk:Infoblox

Restrictions

The object does not support the following operations:

  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): name.

The following fields are required to create this object:

Field Notes
idp  
name  

comment

comment

The descriptive comment for the SAML authentication service.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

idp

idp

The SAML Identity Provider to use for authentication.

Type

A/An The SAML Identity Provider structure struct.

Create

The field is required on creation.

Search

The field is not available for search.

name

name

The name of the SAML authentication service.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

session_timeout

session_timeout

The session timeout in seconds.

Type

Unsigned integer.

Create

The default value is 1800.

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
comment String N N N : = ~
idp struct Y N N N/A
name String Y N Y : = ~
session_timeout Unsigned int N N N N/A