# raw swagger spec link: # https://raw.githubusercontent.com/GluuFederation/oxd/version_4.0/oxd-server/src/main/resources/swagger.yaml # https://gluu.org/swagger-ui/?url=https://raw.githubusercontent.com/GluuFederation/oxd/version_4.0/oxd-server/src/main/resources/swagger.yaml#/developers/setup-client openapi: 3.0.1 info: title: oxd-server description: oxd-server contact: email: yuriyz@gluu.org license: name: License url: https://github.com/GluuFederation/oxd/blob/master/license.md version: "4.2" servers: - url: https://gluu.org/ tags: - name: developers description: Operations available to regular developers paths: /health-check: get: tags: - developers summary: Health Check description: Health Check endpoint is for quick check whether oxd-server is alive. operationId: health-check responses: 200: description: OK content: {} /register-site: post: tags: - developers summary: Register Site description: Registers site at oxd-server operationId: register-site requestBody: content: application/json: schema: title: RegisterSiteParams required: - redirect_uris type: object properties: redirect_uris: type: array description: Provide the list of redirection URIs. The first URL is where the user will be redirected after successful authorization at the OpenID Connect Provider (OP). example: - https://client.example.org/cb items: type: string op_configuration_endpoint: type: string example: https://op.example.com/acme/.well-known/openid-configuration description: The openid configuration endpoint URL. If missing, then either it must be present in defaults or `op_host` must be defined. op_host: type: string description: Deprecated in favor of `op_configuration_endpoint`. It will be removed in future version(s). Provide the URL of OpenID Provider (OP) in this field. If missing, then `op_configuration_endpoint` must be defined. deprecated: true example: https:// op_discovery_path: type: string example: /oxauth deprecated: true description: Deprecated in favor of `op_configuration_endpoint`. It will be removed in future version(s). Provide path to the OpenID Connect Provider's discovery document in this field. For example, if it is 'https://example.com/.well-known/openid-configuration' then the path is blank. But if it is 'https://example.com/oxauth/.well-known/openid-configuration' then the path is '/oxauth' post_logout_redirect_uris: type: array description: Provide the URLs supplied by the RP to request that the user be redirected to this location after a logout has been performed. example: - https://client.example.org/logout/page1 - https://client.example.org/logout/page2 - https://client.example.org/logout/page3 items: type: string response_types: type: array description: Provide a list of the OAuth 2.0 response_type values that the Client is declaring that it will restrict itself to using. If omitted, the default is that the Client will use only the code response type. example: - code items: type: string grant_types: type: array description: Provide a list of the OAuth 2.0 grant types that the Client is declaring that it will restrict itself to using. example: - authorization_code - client_credentials items: type: string scope: type: array description: Provide list of scope which are used during authentication to authorize access to resource. example: - openid items: type: string acr_values: type: array description: Provide Returns the Default requested Authentication Context Class Reference values. example: - basic items: type: string client_name: type: string description: oxd will generate its own non-human readable name by default if client_name is not specified client_jwks_uri: type: string description: Provide the URL for the Client's JSON Web Key Set (JWK) document containing key(s) that are used for signing requests to the OP. The JWK Set may also contain the Client's encryption keys(s) that are used by the OP to encrypt the responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is required for all keys in the document to indicate each key's intended usage . client_token_endpoint_auth_method: type: string description: Provide the requested authentication method for the Token Endpoint. Valid values are none, client_secret_basic, client_secret_post, client_secret_jwt, private_key_jwt, access_token, tls_client_auth, self_signed_tls_client_auth. client_token_endpoint_auth_signing_alg: type: string description: Provide the Requested Client Authentication method for the Token Endpoint. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512. client_request_uris: type: array description: Provide a list of request_uri values that are pre-registered by the Client for use at the Authorization Server. items: type: string client_frontchannel_logout_uris: type: array description: Provide frontchannel logout uris. items: type: string client_sector_identifier_uri: type: string description: Provide the URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values. contacts: type: array description: Provide a list of e-mail addresses for people allowed to administer the information for this Client example: - foo_bar@spam.org items: type: string ui_locales: type: array description: Provide ui_locales, which can be used to pass the localization from the client application to the server application in the authorize request. items: type: string claims_locales: type: array description: Provide claims_locales, which end-user's preferred languages and scripts for Claims being returned. items: type: string claims_redirect_uri: type: array items: type: string client_id: type: string description: client id of existing client, ignores all other parameters and skips new client registration forcing to use existing client (client_secret is required if this parameter is set). client_secret: type: string description: client secret of existing client, must be used together with client_id access_token_as_jwt: type: boolean description: specifies whether access_token should be return as JWT or not. Default value is false. access_token_signing_alg: type: string description: sets signing algorithm used for JWT signing. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512 rpt_as_jwt: type: boolean description: specifies whether RPT should be return as JWT or not. Default value is false. logo_uri: type: string description: specifies an URL that references a logo for the Client application. example: https://client.example.org/logo.png client_uri: type: string description: specifies an URL of the home page of the Client. example: https://client.example.org/page policy_uri: type: string description: specifies an URL that the Relying Party Client provides to the End-User to read about the how the profile data will be used. example: https://client.example.org/page front_channel_logout_session_required: type: boolean description: specifies if front channel logout session required. example: true tos_uri: type: string description: specifies an URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms. example: https://client.example.org/page jwks: type: string description: Client's JSON Web Key Set (JWK) document, passed by value. The semantics of the jwks parameter are the same as the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client can use jwks_uri, it must not use jwks. One significant downside of jwks is that it does not enable key rotation. The jwks_uri and jwks parameters must not be used together. example: '{"key1": "value1", "key2": "value2"}' id_token_binding_cnf: type: string example: 4NRB1-0XZABZI9E6-5SM3R tls_client_auth_subject_dn: type: string example: www.test.com run_introspection_script_beforeaccess_token_as_jwt_creation_and_include_claims: type: boolean description: choose to run introspection script before access_token_as_jwt creation and include claims. example: true id_token_signed_response_alg: type: string description: choose the JWS alg algorithm (JWA) required for the ID Token issued to this client_id. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512 id_token_encrypted_response_alg: type: string description: choose the JWE alg algorithm (JWA) required for encrypting the ID Token issued to this client_id. Valid values are RSA1_5, RSA-OAEP, A128KW, A256KW id_token_encrypted_response_enc: type: string description: choose the JWE enc algorithm (JWA) required for symmetric encryption of the ID Token issued to this client_id. Valid values are A128CBC+HS256, A256CBC+HS512, A128GCM, A256GCM user_info_signed_response_alg: type: string description: choose the JWS alg algorithm (JWA) required for UserInfo responses. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512 user_info_encrypted_response_alg: type: string description: choose the JWE alg algorithm (JWA) required for encrypting UserInfo responses. Valid values are RSA1_5, RSA_OAEP, A128KW, A256KW user_info_encrypted_response_enc: type: string description: choose the JWE enc algorithm (JWA) required for symmetric encryption of UserInfo responses. Valid values are A128CBC+HS256, A256CBC+HS512, A128GCM, A256GCM request_object_signing_alg: type: string description: choose the JWS alg algorithm (JWA) that must be required by the Authorization Server. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512 request_object_encryption_alg: type: string description: choose the JWE alg algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP. Valid values are RSA1_5, RSA_OAEP, A128KW, A256KW request_object_encryption_enc: type: string description: choose the JWE enc algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP. Valid values are A128CBC+HS256, A256CBC+HS512, A128GCM, A256GCM default_max_age: type: integer description: specifies the Default Maximum Authentication Age. example: 1000000 require_auth_time: type: boolean description: specifies the Boolean value specifying whether the auth_time claim in the id_token is required. It is required when the value is true. The auth_time claim request in the request object overrides this setting. example: true initiate_login_uri: type: string description: specifies the URI using the https scheme that the authorization server can call to initiate a login at the client. example: https://client.example.org/authorization/page authorized_origins: type: array description: specifies authorized JavaScript origins. items: type: string example: "" access_token_lifetime: type: integer description: specifies the Client-specific access token expiration. example: 100000000 software_id: type: string description: specifies a unique identifier string (UUID) assigned by the client developer or software publisher used by registration endpoints to identify the client software to be dynamically registered. example: 4NRB1-0XZABZI9E6-5SM3R software_version: type: string description: specifies a version identifier string for the client software identified by 'software_id'. The value of the 'software_version' should change on any update to the client software identified by the same 'software_id'. example: "2.1" software_statement: type: string description: specifies a software statement containing client metadata values about the client software as claims. This is a string value containing the entire signed JWT. custom_attributes: type: object additionalProperties: type: string description: specifies custom attribute map copy. sync_client_from_op: type: boolean description: specifies whether to sync client from OP. Default value is false. example: false sync_client_period_in_seconds: type: integer description: specifies period after which client can sync again with OP. Default value is 86400 (in seconds). example: 86400 allow_spontaneous_scopes: type: boolean description: specifies whether to allow spontaneous scopes for client. The default value is false example: false spontaneous_scopes: type: array description: list of spontaneous scopes (regexp against which validation is performed). items: type: string example: ["^transaction:.+$", "^/user/[^/]+/.+$"] required: false responses: 200: description: OK content: application/json: schema: title: RegisterSiteResponse required: - op_host - oxd_id type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 op_host: type: string example: https:// client_id: type: string example: '@!1736.179E.AA60.16B2!0001!8F7C.B9AB!0008!A2BB.9AE6.5F14.B387' client_name: type: string example: TestClientName client_secret: type: string example: f436b936-03fc-433f-9772-53c2bc9e1c74 client_registration_access_token: type: string example: d836df94-44b0-445a-848a-d43189839b17 client_registration_client_uri: type: string example: https:///oxauth/restv1/register?client_id=@!1736.179E.AA60.16B2!0001!8F7C.B9AB!0008!A2BB.9AE6.5F14.B387 client_id_issued_at: type: integer example: 1501854943 client_secret_expires_at: type: integer example: 1501941343 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: RegisterSiteParams /get-client-token: post: tags: - developers summary: Get Client Token description: Gets Client Token operationId: get-client-token requestBody: content: application/json: schema: title: GetClientTokenParams required: - client_id - client_secret - op_configuration_endpoint type: object properties: op_configuration_endpoint: type: string example: https://op.example.com/acme/.well-known/openid-configuration description: The openid configuration endpoint URL. If missing, then `op_host` must be defined. op_host: type: string example: https:// deprecated: true description: Deprecated in favor of `op_configuration_endpoint`. It will be removed in future version(s). Provide the URL of OpenID Provider (OP) in this field. If missing, then `op_configuration_endpoint` must be defined. op_discovery_path: type: string example: /oxauth deprecated: true description: Deprecated in favor of `op_configuration_endpoint`. It will be removed in future version(s). Provide path to the OpenID Connect Provider's discovery document in this field. For example, if it is 'https://example.com/.well-known/openid-configuration' then the path is blank. But if it is 'https://example.com/oxauth/.well-known/openid-configuration' then the path is '/oxauth' scope: type: array example: - openid items: type: string client_id: type: string example: '@!1736.179E.AA60.16B2!0001!8F7C.B9AB!0008!A2BB.9AE6.5F14.B387' client_secret: type: string example: f436b936-03fc-433f-9772-53c2bc9e1c74 authentication_method: type: string description: if value is missed then basic authentication is used. Otherwise it's possible to set `private_key_jwt` value for Private Key authentication. algorithm: type: string description: optional but is required if authentication_method=private_key_jwt. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512 key_id: type: string description: optional but is required if authentication_method=private_key_jwt. It has to be valid key id from key store. required: false responses: 200: description: OK content: application/json: schema: title: GetClientTokenResponse required: - access_token - expires_in - refresh_token - scope type: object properties: scope: type: array example: - openid - oxd items: type: string access_token: type: string example: b75434ff-f465-4b70-92e4-b7ba6b6c58f2 expires_in: type: integer example: 299 refresh_token: type: string 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetClientTokenParams /introspect-access-token: post: tags: - developers summary: Introspect Access Token description: Introspect Access Token operationId: introspect-access-token parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: IntrospectAccessTokenParams required: - access_token - oxd_id type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 access_token: type: string example: b75434ff-f465-4b70-92e4-b7ba6b6c58f2 required: false responses: 200: description: OK content: application/json: schema: title: IntrospectAccessTokenResponse required: - acr_values - active - aud - client_id - exp - extension_field - iat - iss - jti - nbf - scope - sub - token_type - username type: object properties: active: type: boolean example: true client_id: type: string example: '@!1736.179E.AA60.16B2!0001!8F7C.B9AB!0008!A2BB.9AE6.5F14.B387' username: type: string example: John Black scope: type: array items: type: string token_type: type: string example: bearer sub: type: string example: jblack aud: type: string example: l238j323ds-23ij4 iss: type: string example: https://as.gluu.org/ exp: type: integer description: number of seconds since January 1 1970 UTC, indicating when this token will expire format: int64 example: 1535709072 iat: type: integer description: number of seconds since January 1 1970 UTC, indicating when the token was issued at format: int64 example: 1535709072 nbf: type: integer description: number of seconds since January 1 1970 UTC, indicating when the token not to be used before format: int64 example: 1535709072 jti: type: string description: a unique identifier for the JWT acr_values: type: array example: - basic items: type: string extension_field: type: string example: twenty-seven 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: IntrospectAccessTokenParams /update-site: post: tags: - developers summary: Update Site description: Updates site at oxd-server. If something changes in a pre-registered client, you can use this API to update your client in the OP. operationId: update-site parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: UpdateSiteParams required: - oxd_id type: object properties: oxd_id: type: string example: 6F9619FF-8B86-D011-B42D-00CF4FC964FF redirect_uris: type: array description: Provide the list of redirection URIs. The first URL is where the user will be redirected after successful authorization at the OpenID Connect Provider (OP). example: - https://client.example.org/cb items: type: string post_logout_redirect_uris: type: array example: - https://client.example.org/logout/page1 - https://client.example.org/logout/page2 - https://client.example.org/logout/page3 items: type: string response_types: type: array example: - code items: type: string grant_types: type: array example: - authorization_code - client_credentials items: type: string scope: type: array example: - openid items: type: string acr_values: type: array example: - basic items: type: string client_jwks_uri: type: string client_token_endpoint_auth_method: type: string client_request_uris: type: array items: type: string client_sector_identifier_uri: type: string contacts: type: array example: - foo_bar@spam.org items: type: string ui_locales: type: array items: type: string claims_locales: type: array items: type: string access_token_as_jwt: type: boolean description: specifies whether access_token should be return as JWT or not. Default value is false. access_token_signing_alg: type: string description: sets signing algorithm used for JWT signing. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512 rpt_as_jwt: type: boolean description: specifies whether RPT should be return as JWT or not. Default value is false. claims_redirect_uri: type: array items: type: string client_token_endpoint_auth_signing_alg: type: string description: Provide the Requested Client Authentication method for the Token Endpoint. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512. client_name: type: string description: oxd will generate its own non-human readable name by default if client_name is not specified logo_uri: type: string description: specifies an URL that references a logo for the Client application. example: https://client.example.org/logo.png client_uri: type: string description: specifies an URL of the home page of the Client. example: https://client.example.org/page policy_uri: type: string description: specifies an URL that the Relying Party Client provides to the End-User to read about the how the profile data will be used. example: https://client.example.org/page front_channel_logout_session_required: type: boolean description: specifies if front channel logout session required. example: true tos_uri: type: string description: specifies an URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms. example: https://client.example.org/page jwks: type: string description: Client's JSON Web Key Set (JWK) document, passed by value. The semantics of the jwks parameter are the same as the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client can use jwks_uri, it must not use jwks. One significant downside of jwks is that it does not enable key rotation. The jwks_uri and jwks parameters must not be used together. example: '{"key1": "value1", "key2": "value2"}' id_token_binding_cnf: type: string example: 4NRB1-0XZABZI9E6-5SM3R tls_client_auth_subject_dn: type: string example: www.test.com run_introspection_script_beforeaccess_token_as_jwt_creation_and_include_claims: type: boolean description: choose to run introspection script before access_token_as_jwt creation and include claims. example: true id_token_signed_response_alg: type: string description: choose the JWS alg algorithm (JWA) required for the ID Token issued to this client_id. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512 id_token_encrypted_response_alg: type: string description: choose the JWE alg algorithm (JWA) required for encrypting the ID Token issued to this client_id. Valid values are RSA1_5, RSA-OAEP, A128KW, A256KW id_token_encrypted_response_enc: type: string description: choose the JWE enc algorithm (JWA) required for symmetric encryption of the ID Token issued to this client_id. Valid values are A128CBC+HS256, A256CBC+HS512, A128GCM, A256GCM user_info_signed_response_alg: type: string description: choose the JWS alg algorithm (JWA) required for UserInfo responses. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512 user_info_encrypted_response_alg: type: string description: choose the JWE alg algorithm (JWA) required for encrypting UserInfo responses. Valid values are RSA1_5, RSA_OAEP, A128KW, A256KW user_info_encrypted_response_enc: type: string description: choose the JWE enc algorithm (JWA) required for symmetric encryption of UserInfo responses. Valid values are A128CBC+HS256, A256CBC+HS512, A128GCM, A256GCM request_object_signing_alg: type: string description: choose the JWS alg algorithm (JWA) that must be required by the Authorization Server. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512 request_object_encryption_alg: type: string description: choose the JWE alg algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP. Valid values are RSA1_5, RSA_OAEP, A128KW, A256KW request_object_encryption_enc: type: string description: choose the JWE enc algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP. Valid values are A128CBC+HS256, A256CBC+HS512, A128GCM, A256GCM default_max_age: type: integer description: specifies the Default Maximum Authentication Age. example: 1000000 require_auth_time: type: boolean description: specifies the Boolean value specifying whether the auth_time claim in the id_token is required. It is required when the value is true. The auth_time claim request in the request object overrides this setting. example: true initiate_login_uri: type: string description: specifies the URI using the https scheme that the authorization server can call to initiate a login at the client. example: https://client.example.org/authorization/page authorized_origins: type: array description: specifies authorized JavaScript origins. items: type: string example: "" access_token_lifetime: type: integer description: specifies the Client-specific access token expiration. example: 100000000 software_id: type: string description: specifies a unique identifier string (UUID) assigned by the client developer or software publisher used by registration endpoints to identify the client software to be dynamically registered. example: 4NRB1-0XZABZI9E6-5SM3R software_version: type: string description: specifies a version identifier string for the client software identified by 'software_id'. The value of the 'software_version' should change on any update to the client software identified by the same 'software_id'. example: "2.1" software_statement: type: string description: specifies a software statement containing client metadata values about the client software as claims. This is a string value containing the entire signed JWT. custom_attributes: type: object additionalProperties: type: string description: specifies custom attribute map copy. sync_client_from_op: type: boolean description: specifies whether to sync client from OP. Default value is false. example: false sync_client_period_in_seconds: type: integer description: specifies period after which client can sync again with OP. Default value is 86400 (in seconds). example: 86400 allow_spontaneous_scopes: type: boolean description: specifies whether to allow spontaneous scopes for client. The default value is false example: false spontaneous_scopes: type: array description: list of spontaneous scopes (regexp against which validation is performed). items: type: string example: ["^transaction:.+$", "^/user/[^/]+/.+$"] required: false responses: 200: description: OK content: application/json: schema: title: UpdateSiteResponse required: - oxd_id type: object properties: oxd_id: $ref: '#/components/schemas/oxd_id' 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: UpdateSiteParams /remove-site: post: tags: - developers summary: Remove Site description: Removes site from oxd-server operationId: remove-site parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: RemoveSiteParams required: - oxd_id type: object properties: oxd_id: type: string example: 6F9619FF-8B86-D011-B42D-00CF4FC964FF required: false responses: 200: description: OK content: application/json: schema: title: RemoveSiteResponse required: - oxd_id type: object properties: oxd_id: $ref: '#/components/schemas/oxd_id' 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: RemoveSiteParams /get-authorization-url: post: tags: - developers summary: Get Authorization Url description: Gets authorization url operationId: get-authorization-url parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: GetAuthorizationUrlParams required: - oxd_id type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 scope: type: array example: - openid items: type: string acr_values: type: array example: - basic items: type: string prompt: type: string state: type: string nonce: type: string redirect_uri: type: string example: https://client.example.org/cb response_types: type: array description: Provide a list of the OAuth 2.0 response_type values that the Client is declaring that it will restrict itself to using. If omitted, the default is that the Client will use only the code response type. example: - code items: type: string custom_parameters: type: object additionalProperties: type: string params: type: object additionalProperties: type: string required: false responses: 200: description: OK content: application/json: schema: title: GetAuthorizationUrlResponse required: - authorization_url type: object properties: authorization_url: type: string example: https:///oxauth/restv1/authorize?response_type=code&client_id=@!1736.179E.AA60.16B2!0001!8F7C.B9AB!0008!8A36.24E1.97DE.F4EF&redirect_uri=https://192.168.200.95/&scope=openid+profile+email+uma_protection+uma_authorization&state=473ot4nuqb4ubeokc139raur13&nonce=lbrdgorr974q66q6q9g454iccm 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetAuthorizationUrlParams /get-tokens-by-code: post: tags: - developers summary: Get Tokens By Code description: Get tokens by code operationId: get-tokens-by-code parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: GetTokensByCodeParams required: - code - oxd_id - state type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 code: type: string example: 0b9f1518-15aa-47b2-9477-d4c607447e18 state: type: string example: 6q1ec90hn6ui4ipigv91hrbodj required: false responses: 200: description: OK content: application/json: schema: title: GetTokensByCodeResponse required: - access_token - expires_in - id_token - id_token_claims - refresh_token type: object properties: access_token: type: string example: b75434ff-f465-4b70-92e4-b7ba6b6c58f2 expires_in: type: integer example: 299 id_token: type: string example: eyJraWQiOiI5MTUyNTU1Ni04YmIwLTQ2MzYtYTFhYy05ZGVlNjlhMDBmYWUiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJp refresh_token: type: string example: 33d7988e-6ffb-4fe5-8c2a-0e158691d446 id_token_claims: type: object properties: {} 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetTokensByCodeParams /get-user-info: post: tags: - developers summary: Get User Info description: Get User Info operationId: get-user-info parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: GetUserInfoParams required: - access_token - oxd_id type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 access_token: type: string example: 88bba7f5-961c-4b71-8053-9ab35f1ad395 id_token: type: string required: false responses: 200: description: OK content: application/json: schema: title: GetUserInfoResponse type: object additionalProperties: type: object properties: {} 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetUserInfoParams /get-logout-uri: post: tags: - developers summary: Get Logout URL description: Get Logout URL operationId: get-logout-uri parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: GetLogoutUriParams required: - id_token_hint - oxd_id - post_logout_redirect_uri - session_state - state type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 id_token_hint: type: string example: eyJ0 ... NiJ9.eyJ1c ... I6IjIifX0.DeWt4Qu ... ZXso post_logout_redirect_uri: type: string example: https://client.example.org/cb state: type: string session_state: type: string required: false responses: 200: description: OK content: application/json: schema: title: GetLogoutUriResponse required: - uri type: object properties: uri: type: string example: https:///oxauth/seam/resource/restv1/oxauth/end_session?id_token_hint=eyJraWQiOiI1YmM2ZGM3MS0xYjA1LTQ5YzMtYWU3MC0zYTg4Y2ZiMjQwN2QiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwczovL2NlLWRldi5nbHV1Lm9yZyIsImF1ZCI6IkAhNUE1OC5BRTBELkQzODMuMUU0NiEwMDAxIUUzOEIuN0RCRSEwMDA4IUE3MTkuOTU4QS41QjdGLkVBQkMiLCJleHAiOjE0OTAwMTk5MjEsImlhdCI6MTQ5MDAxNjMyMSwibm9uY2UiOiJkNGdsbmtndHAxYWlqZ3JnY3V2cGp1N2k3cCIsImF1dGhfdGltZSI6MTQ5MDAxNjI3MiwiYXRfaGFzaCI6Im1Xa2NXQzZ6NC1qN0ZNX0ctX0tYMWciLCJveFZhbGlkYXRpb25VUkkiOiJodHRwczovL2NlLWRldi5nbHV1Lm9yZy9veGF1dGgvb3BpZnJhbWUiLCJveE9wZW5JRENvbm5lY3RWZXJzaW9uIjoib3BlbmlkY29ubmVjdC0xLjAiLCJzdWIiOiJONHRLRncyLVpDWTVWN0FhQmdpMnNHRWdDR0t0Tlg2LS01M2FQbmZFYk5zIn0.PvCdzPnMwqPNUw1bzd8tvzpJqYu-P2iCTnELr85ZaJTG8_Fdj3EruLgUBa-emeum3j29cFgdjFPx6WplfCV1GnehOieXjDiAAE85fy-stxXwII3xrva5ZjG0FnTYnJLoRmy0BWMjFC2IdCoISJI9imcfvmQmlvNmU0EjLS02cJf3JAaqEaM-FJWdQv8end9-Sq2bcp6ME3voRjV30ps_7jcDdlM_hW3M_e3RdrXYCDifbl_1jaNip5tb6_bLpgTADDoLT3fTvACRN057e2GCkSYdxvVhIjfDsjnOhk5n3TDcWedriu99H8-sNXyI_aBr3HAXd37CsgmdfIJcgUNJJw 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetLogoutUriParams /get-access-token-by-refresh-token: post: tags: - developers summary: Get Access Token By Refresh Token description: Get Access Token By Refresh Token operationId: get-access-token-by-refresh-token parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: GetAccessTokenByRefreshTokenParams required: - oxd_id - refresh_token - scope type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 refresh_token: type: string example: 33d7988e-6ffb-4fe5-8c2a-0e158691d446 scope: type: array example: - openid items: type: string required: false responses: 200: description: OK content: application/json: schema: title: GetAccessTokenByRefreshTokenResponse required: - access_token - expires_in - refresh_token - scope type: object properties: scope: type: array example: - openid - profile - uma_protection - email items: type: string access_token: type: string example: b75434ff-f465-4b70-92e4-b7ba6b6c58f2 expires_in: type: integer example: 299 refresh_token: type: string example: 33d7988e-6ffb-4fe5-8c2a-0e158691d446 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetAccessTokenByRefreshTokenParams /uma-rs-protect: post: tags: - developers summary: UMA RS Protect Resources description: UMA RS Protect Resources. It's important to have a single HTTP method, mentioned only once within a given path in JSON, otherwise, the operation will fail. operationId: uma-rs-protect parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: UmaRsProtectParams required: - overwrite - oxd_id - resources type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 overwrite: type: boolean resources: type: array items: $ref: '#/components/schemas/RsResource' required: false responses: 200: description: OK content: application/json: schema: title: UmaRsProtectResponse required: - oxd_id type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: UmaRsProtectParams /uma-rs-modify: post: tags: - developers summary: UMA RS Modify Resources description: UMA RS Modify Resource. This end-point can be used to modify one resource at a time from whole set of UMA resources of cient. operationId: uma-rs-modify parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: UmaRsModifyParams required: - http_method - oxd_id - path type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 path: type: string example: /ws/document http_method: type: string example: POST scopes: type: array items: type: string example: http://photoz.example.com/dev/actions/view scope_expression: type: string required: false responses: 200: description: OK content: application/json: schema: title: UmaRsModifyResponse required: - oxd_id type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: UmaRsModifyParams /uma-rs-check-access: post: tags: - developers summary: UMA RS Check Access description: UMA RS Check Access operationId: uma-rs-check-access parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: UmaRsCheckAccessParams required: - http_method - oxd_id - path - rpt type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 rpt: type: string path: type: string http_method: type: string scopes: type: array example: - http://photoz.example.com/dev/actions/all - http://photoz.example.com/dev/actions/add items: type: string required: false responses: 200: description: OK content: application/json: schema: title: UmaRsCheckAccessResponse required: - access - ticket type: object properties: access: type: string description: Possible values are granted, denied example: granted ticket: type: string 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: UmaRsCheckAccessParams /introspect-rpt: post: tags: - developers summary: Introspect RPT description: Introspect RPT operationId: introspect-rpt parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: IntrospectRptParams required: - oxd_id - rpt type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 rpt: type: string required: false responses: 200: description: OK content: application/json: schema: title: IntrospectRptResponse required: - active - aud - client_id - exp - iat - iss - nbf - permissions type: object properties: active: type: boolean example: true exp: type: integer description: number of seconds since January 1 1970 UTC, indicating when this token will expire format: int64 example: 1535709072 iat: type: integer description: number of seconds since January 1 1970 UTC, indicating when the token was issued at format: int64 example: 1535709072 nbf: type: integer description: number of seconds since January 1 1970 UTC, indicating when the token not to be used before format: int64 example: 1535709072 client_id: type: string example: '@!DBE5.84F8.631A.9172!0001!CD07.49BE!0008!0ED4.C61D.6FA7.8F42' sub: type: string aud: type: string example: '@!DBE5.84F8.631A.9172!0001!CD07.49BE!0008!0ED4.C61D.6FA7.8F42' iss: type: string example: http://as.com jti: type: string permissions: type: array items: type: object properties: {} 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: IntrospectRptParams /uma-rp-get-rpt: post: tags: - developers summary: UMA RP Get RPT description: UMA RP Get RPT operationId: uma-rp-get-rpt parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: UmaRpGetRptParams required: - oxd_id - ticket type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 ticket: type: string claim_token: type: string claim_token_format: type: string pct: type: string rpt: type: string scope: type: array example: - openid items: type: string state: type: string params: type: object additionalProperties: type: string required: false responses: 200: description: OK content: application/json: schema: title: UmaRpGetRptResponse required: - access_token - pct - token_type - updated type: object properties: pct: type: string updated: type: boolean access_token: type: string example: b75434ff-f465-4b70-92e4-b7ba6b6c58f2 token_type: type: string example: bearer 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: UmaRpGetRptParams /uma-rp-get-claims-gathering-url: post: tags: - developers summary: UMA RP Get Claims Gathering URL description: UMA RP Get Claims Gathering URL operationId: uma-rp-get-claims-gathering-url parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: UmaRpGetClaimsGatheringUrlParams required: - claims_redirect_uri - oxd_id - ticket type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 ticket: type: string example: fba00191-59ab-4ed6-ac99-a786a88a9f40 state: type: string claims_redirect_uri: type: string example: https://client.example.com/cb custom_parameters: type: object additionalProperties: type: string required: false responses: 200: description: OK content: application/json: schema: title: UmaRpGetClaimsGatheringUrlResponse required: - state - url type: object properties: url: type: string example: https:///oxauth/restv1/uma/gather_claims?client_id@!1736.179E.AA60.16B2!0001!8F7C.B9AB!0008!4508.BF20.9B81.E904&ticket=fba00191-59ab-4ed6-ac99-a786a88a9f40&claims_redirect_uri=https://client.example.com/cb&state=d871gpie16np0f5kfv936sc33k state: type: string example: d871gpie16np0f5kfv936sc33k 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: UmaRpGetClaimsGatheringUrlParams /get-jwks: post: tags: - developers summary: Get JSON Web Key Set description: Get JSON Web Key Set operationId: get-json-web-key-set parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: GetJwksParams required: - op_configuration_endpoint type: object properties: op_configuration_endpoint: type: string example: https://op.example.com/acme/.well-known/openid-configuration description: The openid configuration endpoint URL. If missing, then `op_host` must be defined. op_host: type: string example: https:// deprecated: true description: Deprecated in favor of `op_configuration_endpoint`. It will be removed in future version(s). Provide the URL of OpenID Provider (OP) in this field. If missing, then `op_configuration_endpoint` must be defined. op_discovery_path: type: string example: /oxauth deprecated: true description: Deprecated in favor of `op_configuration_endpoint`. It will be removed in future version(s). Provide path to the OpenID Connect Provider's discovery document in this field. For example, if it is 'https://example.com/.well-known/openid-configuration' then the path is blank. But if it is 'https://example.com/oxauth/.well-known/openid-configuration' then the path is '/oxauth' required: false responses: 200: description: OK content: application/json: schema: title: GetJwksResponse required: - keys type: object properties: keys: type: array items: $ref: '#/components/schemas/JsonWebKey' 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetJwksParams /get-issuer: post: tags: - developers summary: Get Issuer description: Get Issuer operationId: get-issuer requestBody: content: application/json: schema: title: GetIssuerParams required: - resource type: object properties: resource: type: string example: admin@jenkins-ldap.gluu.org description: Identifier for the target End-User that is the subject of the discovery request. required: false responses: 200: description: OK content: application/json: schema: title: GetIssuerResponse type: object properties: subject: type: string example: admin@jenkins-ldap.gluu.org links: type: array items: $ref: '#/components/schemas/WebFingerLink' 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetJwksParams /get-discovery: post: tags: - developers summary: Get OP Discovery Configuration description: Get OP Discovery Configuration operationId: get-discovery requestBody: content: application/json: schema: title: GetDiscoveryParams required: - op_configuration_endpoint type: object properties: op_configuration_endpoint: type: string example: https://op.example.com/acme/.well-known/openid-configuration description: The openid configuration endpoint URL. If missing, then `op_host` must be defined. op_host: type: string example: https:// deprecated: true description: Deprecated in favor of `op_configuration_endpoint`. It will be removed in future version(s). Provide the URL of OpenID Provider (OP) in this field. If missing, then `op_configuration_endpoint` must be defined. op_discovery_path: type: string example: /oxauth deprecated: true description: Deprecated in favor of `op_configuration_endpoint`. It will be removed in future version(s). Provide path to the OpenID Connect Provider's discovery document in this field. For example, if it is 'https://example.com/.well-known/openid-configuration' then the path is blank. But if it is 'https://example.com/oxauth/.well-known/openid-configuration' then the path is '/oxauth' required: false responses: 200: description: OK content: application/json: schema: title: GetDiscoveryResponse type: object properties: issuer: type: string example: https:// authorization_endpoint: type: string example: https:///oxauth/restv1/authorize token_endpoint: type: string example: https:///oxauth/restv1/token token_revocation_endpoint: type: string example: https:///oxauth/restv1/token/v1 user_info_endpoint: type: string example: https:///oxauth/restv1/userinfo client_info_endpoint: type: string example: https:///oxauth/restv1/clientinfo check_session_iframe: type: string example: https:///oxauth/opiframe.htm end_session_endpoint: type: string example: https:///oxauth/restv1/end_session jwks_uri: type: string example: https:///oxauth/restv1/jwks registration_endpoint: type: string example: https:///oxauth/restv1/register id_generation_endpoint: type: string example: https:///oxauth/restv1/id introspection_endpoint: type: string example: https:///oxauth/restv1/introspection scopes_supported: type: array example: - owner - casa - address - clientinfo - user_name - openid - profile - uma_protection - admin - permission - manage - phone - mobile_phone - name - oxd - email items: type: string response_types_supported: type: array example: - token id_token - token code id_token - token - token code - code - code id_token - id_token items: type: string grant_types_supported: type: array example: - authorization_code - refresh_token - urn:ietf:params:oauth:grant-type:uma-ticket - password - implicit - client_credentials items: type: string acr_values_supported: type: array example: - u2f - super_gluu - otp - auth_ldap_server items: type: string subject_types_supported: type: array example: - public - pairwise items: type: string user_info_signing_alg_values_supported: type: array example: - HS256 - HS384 - HS512 - RS256 - RS384 - RS512 - ES256 - ES384 - ES512 items: type: string user_info_encryption_alg_values_supported: type: array example: - RSA1_5 - RSA-OAEP - A128KW - A256KW items: type: string user_info_encryption_enc_values_supported: type: array example: - RSA1_5 - RSA-OAEP - A128KW - A256KW items: type: string id_token_signing_alg_values_supported: type: array example: - none - HS256 - HS384 - HS512 - RS256 - RS384 - RS512 - ES256 - ES384 - ES512 items: type: string id_token_encryption_alg_values_supported: type: array example: - RSA1_5 - RSA-OAEP - A128KW - A256KW items: type: string id_token_encryption_enc_values_supported: type: array example: - A128CBC+HS256 - A256CBC+HS512 - A128GCM - A256GCM items: type: string request_object_signing_alg_values_supported: type: array example: - none - HS256 - HS384 - HS512 - RS256 - RS384 - RS512 - ES256 - ES384 - ES512 items: type: string request_object_encryption_alg_values_supported: type: array example: - RSA1_5 - RSA-OAEP - A128KW - A256KW items: type: string request_object_encryption_enc_values_supported: type: array example: - A128CBC+HS256 - A256CBC+HS512 - A128GCM - A256GCM items: type: string token_endpoint_auth_methods_supported: type: array example: - client_secret_basic - client_secret_post - client_secret_jwt - private_key_jwt items: type: string token_endpoint_auth_signing_alg_values_supported: type: array example: - HS256 - HS384 - HS512 - RS256 - RS384 - RS512 - ES256 - ES384 - ES512 items: type: string display_values_supported: type: array example: - page - popup items: type: string claim_types_supported: type: array example: - normal items: type: string claims_supported: type: array example: - street_address - country - zoneinfo - birthdate - role - gender - formatted - user_name - phone_mobile_number - preferred_username - locale - inum - updated_at - nickname - email - website - email_verified - profile - locality - phone_number_verified - given_name - middle_name - picture - name - phone_number - postal_code - region - family_name items: type: string id_token_token_binding_cnf_values_supported: type: array example: - tbh items: type: string service_documentation: type: string example: http:// claims_locales_supported: type: array example: - en items: type: string ui_locales_supported: type: array example: - en - es items: type: string claims_parameter_supported: type: boolean example: true request_parameter_supported: type: boolean example: true request_uri_parameter_supported: type: boolean example: true require_request_uri_registration: type: boolean example: true tls_client_certificate_bound_access_tokens: type: boolean example: true front_channel_logout_supported: type: boolean example: true front_channel_logout_session_supported: type: boolean example: true op_policy_uri: type: string example: http:// op_tos_uri: type: string example: http:// scope_to_claims_mapping: type: object properties: {} example: - address: - formatted - postal_code - street_address - locality - country - region - owner: [] - manage: [] - profile: - name - family_name - given_name - middle_name - nickname - preferred_username - profile - picture - website - gender - birthdate - zoneinfo - locale - updated_at - mobile_phone: - phone_mobile_number - phone: - phone_number_verified - phone_number - clientinfo: - name - inum - permission: - role - oxd: [] - email: - email_verified - email - casa: - email - user_name: - user_name - name: [] - openid: [] - uma_protection: [] - admin: [] 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetDiscoveryParams /get-rp-jwks: get: tags: - developers summary: Get Rp JWKS description: Get Rp JWKS operationId: get-rp-jwks responses: 200: description: OK content: application/json: schema: title: GetRpJwksResponse required: - keys type: object properties: keys: type: array items: $ref: '#/components/schemas/JsonWebKey' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetJwksParams /get-request-object-uri: post: tags: - developers summary: Get Request Object Uri description: Get Request Object Uri operationId: get-request-object-uri parameters: - name: Authorization in: header schema: type: string - name: AuthorizationOxdId in: header schema: type: string requestBody: content: application/json: schema: title: GetRequestObjectUriParams required: - oxd_id - oxd_host_url type: object properties: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 params: type: object additionalProperties: type: object request_object_signing_alg: type: string example: RS256 description: choose the JWS alg algorithm (JWA) that must be required by the Authorization Server. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512 oxd_host_url: type: string example: https:// required: false responses: 200: description: OK content: application/json: schema: title: GetRequestObjectUriResponse required: - request_uri type: object properties: request_uri: type: string example: https:///get-request-object/d871gpie16np0f5kfv936sc33k 400: description: Invalid parameters are provided to endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 403: description: Forbidden. Invalid access token provided in Authorization header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codegen-request-body-name: GetRequestObjectUriResponse /get-request-object/{request_object_id}: get: tags: - developers summary: Get Request Object description: Get Request Object operationId: get-request-object parameters: - in: path name: request_object_id schema: type: string required: true description: request object id responses: 200: description: OK content: text/plain: schema: type: string example: eyJraWQiOiIyN2QyMGU2Zi1mNjZlLTQzZTUtOGY5Yi0yNDE3YTRjMjQ1YjB fc2lnX3JzMjU2IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiJodHRw czovL2plbmtpbnMtbGRhcC5nbHV1Lm9yZyIsImlzcyI6IjJmOTk4OWY1LWU4MjAtNGQ5 Yi1iYzAzLWZlZmU4ZDU0YmU4NSIsInJlc3BvbnNlX3R5cGUiOlsiY29kZSJdLCJzdGF0Z SI6IjEya2E0IiwiZXhwIjoxNTkzNjk0OTU2LCJveGRfaWQiOiJhNzMxODdmZi0zODJiLT Q0YzgtYjEzMi0zYjE0YjYwNWY0OTQiLCJpYXQiOjE1OTM2OTQ2NTYsImp0aSI6IjQ5NzF jMWE4LThmYmEtNDExMS1iYWQxLWQ4NmI0MTdiYzBmMCIsImNsaWVudF9pZCI6IjJmOTk4O WY1LWU4MjAtNGQ5Yi1iYzAzLWZlZmU4ZDU0YmU4NSJ9.TIuQm4aj8X2wX9g8aiHs62Y_5y U3sz5jh-PW3egzFIZ99N7TDkYXf6-NM_F9UuFiA8aO7Yjjrl1xjrhmonQxpZ56e2Gyd4-h YI8oTINy2l3iGHNE9Ss7ypZ-PblI7eNoHoshFziCM7VhhBFbOqqxwG8tQ4lxvbcI-BXN_d uxHLvfy7uMrCo1KKyB0TTjqEt5ik1O0V2UPmYqRkN1mObZJvYAA9-vxa5AMu3mf7Wj8CNl FL4pgx_mwo3NTU23_TErL_nI6vf_gfC0UJanGCmUE5hWC_lY9QJi01VRMMNdXVIYUtXtoE F3y4dh77CZuvM9CMVj4g0WBro006UUiC21ow 404: description: Request object not found. content: text/plain: schema: $ref: '#/components/schemas/ErrorResponse' 500: description: Internal error occured. Please check oxd-server.log file for details (usually located in /var/log/oxd-server/oxd-server.log). content: text/plain: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: oxd_id: type: string example: bcad760f-91ba-46e1-a020-05e4281d91b6 Condition: required: - httpMethods - scope_expression - scopes - ticketScopes type: object properties: httpMethods: type: array items: type: string scopes: type: array items: type: string scope_expression: type: array items: type: string ticketScopes: type: array items: type: string RsResource: required: - conditions - path type: object properties: path: type: string conditions: type: array items: $ref: '#/components/schemas/Condition' exp: type: integer description: Resource expiration date in terms of number of seconds since January 1 1970 UTC format: int64 example: 1545709072 iat: type: integer description: Resource creation date in terms of number of seconds since January 1 1970 UTC format: int64 example: 1535709072 JsonWebKey: required: - alg - exp - key_ops - kid - kty - use - x5c - x5t - x5u type: object properties: kid: type: string kty: type: string use: type: string alg: type: string crv: type: string exp: type: integer format: int64 example: 1563964950485 x5c: type: array items: type: string n: type: string e: type: string x: type: string y: type: string ErrorResponse: required: - error - error_description type: object properties: error: type: string error_description: type: string details: type: string WebFingerLink: required: - rel - href type: object properties: rel: type: string href: type: string