federatedrealms : Federated realms object.¶
The federatedrealms is a read-only synthetic object used to retrieve federated realms that are available in the federation. It does not support reading a specific federated realm by reference.
Object Reference¶
References to federatedrealms are object references.
Restrictions¶
The object does not support the following operations:
Create (insert)
Delete
Modify (update)
Permissions
Read by object reference
Global search (searches via the search object)
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): id, name.
id¶
- id¶
Federated realm id.
Type
String.
Search
The field is not available for search.
Notes
The id is part of the base object.
The id cannot be updated.
id cannot be written.
name¶
- name¶
Federated realm name.
Type
String.
Search
The field is not available for search.
Notes
The name is part of the base object.
The name cannot be updated.
name cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
id |
String |
N |
Y |
Y |
N/A |
name |
String |
N |
Y |
Y |
N/A |
