Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

Service

API

Method

Data Models

Workflow

Group

multitenant

/admin/tenant/console/oauth/update

PUT

Tenant

N/A

ADmin tenant

Description

Update tenant oauth configuration

Input

...

Code Block
Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

id

Query

Yes

String

N/A

type

Body

No

Number

N/A

[0,2]

oauthType

Body

No

String

N/A

["urac", "miniurac", "off"]

pin

Body

No

Object

N/A

Environment

secret

Body

No

String

N/A

redirectURI

Body

No

String

N/A

availableEnv

Body

No

Array of strings

N/A

Output

...

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Valid Response Sample
Code Block
languagejs
{ 
  result: true,
  data: true
}

Invalid Response

Error Response Sample
Code Block
languagejs
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

...


Code

Description

400

Business logic required data are missing

450

Unable to find tenant

471

Unable to update tenant

500

You cannot modify or delete a locked record

602

Model error: + %model_error%

...