Jump to

• Request
• Response

Get all ORDS OAuth clients

get

/ords/rest/clients/

Description of the purpose of the client, displayed to the end user during the approval phase of three-legged OAuth. May be null if grant_type is client_credentials; otherwise, must not be null.

Request

Query Parameters

• limit: integer(int32)
  The maximum number of records to return.
• q:
  Filtering is the process of limiting a collection resource by using a per-request dynamic filter definition across multiple page resources, where each page contains a subset of items found in the complete collection. Filtering enables efficient traversal of large collections.

  Examples

  Select an example FilterCriteriaExample OrderByPropertyExample FilterAndOrderExample

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Details of all the ORDS OAuth clients.

Body ()

Root Schema : RestClientCollection

Type: object

Show Source

• count: integer
  Total number of records in the current response.
• hasMore: boolean
  Indicates if there are more records to be retrieved.
• items: array items
• limit: integer
  The actual page size limit on number of records applied by the server.
• links: array links
• offset: integer
  The actual index from which the item resources are returned.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestClientCollectionItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object RestClientCollectionItem
  ORDS OAuth clients

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : RestClientCollectionItem

Type: object

ORDS OAuth clients

Show Source

• about_url: string
  The URL that provides more information for the client
• allowed_origins: string
  The comma-separated list of URL prefixes.
• auth_flow: string
  OAuth flow type.
• client_id: string
  A unique string identifier of a client.
• client_secret: string
  The client secret for slot 1.
• client_secret_2: string
  The client secret for slot 2.
• client_secret_2_issued_on: string
  Date and time when the client secret was generated or issued.
• client_secret_issued_on: string
  Date and time when the client secret was generated or issued.
• code_duration: string
  Duration of the code token in seconds applicable only when authorization code is authorization_code.
• created_by: string
  The user who created the client
• created_on: string
  Date and time when the client was created.
• description: string
  Description of the purpose of the client.
• id: integer
  The original generated client identifier.
• links: array links
• logo_content_type: string
  The content type of the logo.
• logo_image: string
  The logo of the OAuth client.
• name: string
  The name for the client.
• privilege_names: string
  List of comma-separated privileges that the client wants to access.
• redirect_uri: string
  Client-controlled URI to which redirect containing an OAuth access token or error is sent.
• refresh_duration: string
  Duration of refresh token in seconds. NULL duration fallsback to the value in the ORDS instance.
• response_type: string
  OAuth response type
• role_names: string
  The names of the roles that was granted.
• schema_id: string
  The schema registration id.
• support_email: string
  The URI to contact the client for support.
• support_uri: string
  The URI where to contact the client for support.
• token_duration: string
  Duration of the access token in seconds.
• updated_by: string
  The user who updated the client
• updated_on: string
  Date and time when the client was updated.

{
    "type":"object",
    "description":"ORDS OAuth clients",
    "properties":{
        "id":{
            "type":"integer",
            "description":"The original generated client identifier."
        },
        "name":{
            "type":"string",
            "description":"The name for the client."
        },
        "description":{
            "type":"string",
            "description":"Description of the purpose of the client."
        },
        "auth_flow":{
            "type":"string",
            "description":"OAuth flow type."
        },
        "response_type":{
            "type":"string",
            "description":"OAuth response type"
        },
        "client_id":{
            "type":"string",
            "description":"A unique string identifier of a client."
        },
        "client_secret":{
            "type":"string",
            "description":"The client secret for slot 1."
        },
        "client_secret_issued_on":{
            "type":"string",
            "description":"Date and time when the client secret was generated or issued."
        },
        "client_secret_2":{
            "type":"string",
            "description":"The client secret for slot 2."
        },
        "client_secret_2_issued_on":{
            "type":"string",
            "description":"Date and time when the client secret was generated or issued."
        },
        "token_duration":{
            "type":"string",
            "description":"Duration of the access token in seconds. "
        },
        "refresh_duration":{
            "type":"string",
            "description":"Duration of refresh token in seconds. NULL duration fallsback to the value in the ORDS instance."
        },
        "code_duration":{
            "type":"string",
            "description":"Duration of the code token in seconds applicable only when authorization code is authorization_code."
        },
        "redirect_uri":{
            "type":"string",
            "description":"Client-controlled URI to which redirect containing an OAuth access token or error is sent."
        },
        "support_email":{
            "type":"string",
            "description":"The URI to contact the client for support."
        },
        "support_uri":{
            "type":"string",
            "description":"The URI where to contact the client for support."
        },
        "allowed_origins":{
            "type":"string",
            "description":"The comma-separated list of URL prefixes."
        },
        "about_url":{
            "type":"string",
            "description":"The URL that provides more information for the client"
        },
        "logo_content_type":{
            "type":"string",
            "description":"The content type of the logo."
        },
        "logo_image":{
            "type":"string",
            "description":"The logo of the OAuth client."
        },
        "schema_id":{
            "type":"string",
            "description":"The schema registration id."
        },
        "created_by":{
            "type":"string",
            "description":"The user who created the client"
        },
        "created_on":{
            "type":"string",
            "description":"Date and time when the client was created."
        },
        "updated_by":{
            "type":"string",
            "description":"The user who updated the client"
        },
        "updated_on":{
            "type":"string",
            "description":"Date and time when the client was updated."
        },
        "privilege_names":{
            "type":"string",
            "description":"List of comma-separated privileges that the client wants to access."
        },
        "role_names":{
            "type":"string",
            "description":"The names of the roles that was granted."
        },
        "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