Class ListGrantsRequest

Inheritance

object

ListGrantsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.IdentitydomainsService.Requests

Assembly: OCI.DotNetSDK.Identitydomains.dll

Syntax

public class ListGrantsRequest : IOciRequest

Examples

Click here to see an example of how to use ListGrants request.

Properties

AttributeSets

Declaration

[HttpConverter(TargetEnum.Query, "attributeSets", CollectionFormatType.Multi)]
public List<AttributeSets> AttributeSets { get; set; }

Property Value

Type

Description

List<AttributeSets>

A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.

Attributes

Declaration

[HttpConverter(TargetEnum.Query, "attributes")]
public string Attributes { get; set; }

Property Value

Type

Description

string

A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

Authorization

Declaration

[HttpConverter(TargetEnum.Header, "authorization")]
public string Authorization { get; set; }

Property Value

Type	Description
string	The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

Count

Declaration

[HttpConverter(TargetEnum.Query, "count")]
public int? Count { get; set; }

Property Value

Type	Description
int?	OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4).

Filter

Declaration

[HttpConverter(TargetEnum.Query, "filter")]
public string Filter { get; set; }

Property Value

Type

Description

string

OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The maximum number of items to return in a paginated 'List' call.

OpcRetryToken

Declaration

[HttpConverter(TargetEnum.Header, "opc-retry-token")]
public string OpcRetryToken { get; set; }

Property Value

Type	Description
string	A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	The value of the opc-next-page response header from the previous 'List' call.

ResourceTypeSchemaVersion

Declaration

[HttpConverter(TargetEnum.Header, "resource_type_schema_version")]
public string ResourceTypeSchemaVersion { get; set; }

Property Value

Type

Description

string

An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public string SortBy { get; set; }

Property Value

Type	Description
string	OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3).

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }

Property Value

Type	Description
SortOrder?	A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL.

StartIndex

Declaration

[HttpConverter(TargetEnum.Query, "startIndex")]
public int? StartIndex { get; set; }

Property Value

Type	Description
int?	OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on.

Implements

IOciRequest