Jump to

• Request
• Response

Create an ORDS OAuth client

post

/ords/_/db-api/stable/ords/rest/clients/

Creates an ORDS OAuth client.

Request

Supported Media Types

• application/json

Body ()

Root Schema : schema

Type: object

Show Source

• allowed_origins(optional): string
  A comma-separated list of URL prefixes. If the list is empty, any existing origins are removed.
• description(optional): string
  Description of the purpose of the client, displayed to the end user during the approval phase of three-legged OAuth. May be null if p_grant_type is client_credentials; otherwise, must not be null.
• logo_data(optional): string
  the image in base64 format for use in the show code.
• logo_type(optional): string
  the extension of the logo image to be used in the show code.
• name: string
  Name for the client, displayed to the end user during the approval phase of three-legged OAuth. Must be unique.
• privilege_names: string
  List of comma-separated privileges that the client wants to access.
• redirect_uri(optional): string
  Client-controlled URI to which redirect containing an OAuth access token or error will be sent. May be null if p_grant_type is client_credentials; otherwise, must not be null.
• role_names(optional): string
  Is a string of privilege names
• support_email(optional): string
  The email where end users can contact the client for support.
• support_uri(optional): string
  The URI where end users can contact the client for support.

{
    "type":"object",
    "required":[
        "name",
        "privilege_names"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name for the client, displayed to the end user during the approval phase of three-legged OAuth. Must be unique."
        },
        "description":{
            "type":"string",
            "description":"Description of the purpose of the client, displayed to the end user during the approval phase of three-legged OAuth. May be null if p_grant_type is client_credentials; otherwise, must not be null."
        },
        "allowed_origins":{
            "type":"string",
            "description":"A comma-separated list of URL prefixes. If the list is empty, any existing origins are removed."
        },
        "redirect_uri":{
            "type":"string",
            "description":"Client-controlled URI to which redirect containing an OAuth access token or error will be sent. May be null if p_grant_type is client_credentials; otherwise, must not be null."
        },
        "privilege_names":{
            "type":"string",
            "description":"List of comma-separated privileges that the client wants to access."
        },
        "role_names":{
            "type":"string",
            "description":"Is a string of privilege names"
        },
        "support_email":{
            "type":"string",
            "description":"The email where end users can contact the client for support."
        },
        "support_uri":{
            "type":"string",
            "description":"The URI where end users can contact the client for support."
        },
        "logo_type":{
            "type":"string",
            "description":"the extension of the logo image to be used in the show code."
        },
        "logo_data":{
            "type":"string",
            "description":"the image in base64 format for use in the show code."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Details of the ORDS OAuth client that has been created successfully.

Body ()

Root Schema : ResourceItem

Type: object

Additional Properties Allowed: true

Show Source

• links(optional): array links

{
    "type":"object",
    "additionalProperties":true,
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

• href: string
• rel: string

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

400 Response

No name, description or support_email parameter provided or A role name or privilege name does not exist or The list of allowed origins or privilege name is too big or A privilege name is too long.

409 Response

An oauth client with that name already exists.

Back to Top