Jump to

• Request
• Response

Register or Rotate the ORDS OAuth client secret.

post

/ords/rest/clients/{id}/secret/{slotid}

Register or Rotate the ORDS OAuth client secret.

Request

Path Parameters

• id(required): integer
  ID for specific OAuth client.
• slotid(required): integer
  Slot ID for a specific OAuth client; it can only be 1 or 2.

Query Parameters

• revoke_existing: boolean
  Deletes the existing client sessions when TRUE. Default value is FALSE.
• revoke_sessions: boolean
  Deletes the current client sessions when TRUE. Default value is FALSE.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Details of the ORDS OAuth secret has been successfully updated.

Body ()

Root Schema : RestClientSecretItem

Type: object

This object represents a new client secret .

Show Source

• client_secret: string
  The client secret for slot 1.
• client_secret_2: string
  The client secret for slot 2.
• id: integer
  The original generated client identifier.
• links: array links
• name: string
  The name for the client.

{
    "type":"object",
    "description":"This object represents a new client secret .",
    "properties":{
        "id":{
            "type":"integer",
            "description":"The original generated client identifier."
        },
        "name":{
            "type":"string",
            "description":"The name for the client."
        },
        "client_secret":{
            "type":"string",
            "description":"The client secret for slot 1."
        },
        "client_secret_2":{
            "type":"string",
            "description":"The client secret for slot 2."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Back to Top