Update Local AuthenticationOption

PATCH

/authentication-option-local/{object_id}

Authentication

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (AuthenticationOptionLocal)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

AuthenticationOptionLocal

Example:

AuthenticationOptionLocal

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "AuthenticationOptionLocal",
        "attributes": {
            "name": "string",
            "label": "string",
            "isActive": true,
            "preventRegistration": true
        },
        "relationships": {}
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/authentication-option-local/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "AuthenticationOptionLocal",
        "attributes": {
            "name": "string",
            "label": "string",
            "isActive": true,
            "preventRegistration": true
        },
        "relationships": {}
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (AuthenticationOptionLocal)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

AuthenticationOptionLocal

Example:

AuthenticationOptionLocal

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "AuthenticationOptionLocal",
        "attributes": {
            "name": "string",
            "label": "string",
            "isActive": true,
            "preventRegistration": true,
            "type": "local"
        },
        "relationships": {}
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-08 10:51:21

Get Local AuthenticationOption

Create LTI1.3 AuthenticationOption