Class PatchSchemaRequest

Inheritance

object

PatchSchemaRequest

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 PatchSchemaRequest : IOciRequest

Examples

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

Properties

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.

IfMatch

Declaration

[HttpConverter(TargetEnum.Header, "if-match")]
public string IfMatch { get; set; }

Property Value

Type	Description
string	Used to make the request conditional on an ETag

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.

PatchOp

Declaration

[HttpConverter(TargetEnum.Body)]
public PatchOp PatchOp { get; set; }

Property Value

Type	Description
PatchOp	Update the Schema with SCIM Patch schema. Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource. Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

Type

Description

PatchOp

Update the Schema with SCIM Patch schema.
Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute.

Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable:
- The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly.
- The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly.
- Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.
  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below:
Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always:
- If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always.
- If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always.
- The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

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.

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.

SchemaId

Declaration

[Required(ErrorMessage = "SchemaId is required.")]
[HttpConverter(TargetEnum.Path, "schemaId")]
public string SchemaId { get; set; }

Property Value

Type	Description
string	ID of the resource

Remarks

Required

Implements

IOciRequest