Loading src/SOL009/components/SOL009_schemas.yaml +73 −42 Original line number Original line Diff line number Diff line Loading @@ -216,6 +216,19 @@ components: - objectId - objectId SubscriptionAuthentication: SubscriptionAuthentication: description: > * NOTE 1 : The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process. * NOTE 2: As a less secure alternative to OAUTH2_CLIENT_CERT which uses mutual authentication based on X.509 certificates, this mode which uses client password to authenticate may be used in the access token request toward the authorization server (as defined by IETF RFC 6749 [7]), only to support legacy implementations (version 3.4.1 or earlier version of the present document). See clause 8.1 for more details. * NOTE 3: The following values that were included up to version 3.4.1 of the present document have been removed: "BASIC" (to signal the use of the basic HTTP authentication) has been removed because it is insecure. "TLS_CERT" to signal an alternative non-token based authorization method using TLS certificates has been removed because the method is no longer supported. * NOTE 4: The client certificate is established by means outside the scope of the present document. type: object type: object required: required: - authType - authType Loading @@ -224,71 +237,89 @@ components: description: > description: > Defines the types of Authentication / Authorization which the API Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. consumer is willing to accept when receiving a notification. Permitted values: Permitted values (see note 3): * BASIC: In every HTTP request to the notification endpoint, use * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use HTTP Basic authentication with the client credentials. an OAuth 2.0 token, obtained using the client credentials grant type after authenticating * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the using client identifier and client password towards the token endpoint. notification endpoint, use an OAuth 2.0 Bearer token, obtained * OAUTH2_CLIENT_CERT: In every HTTP request to the notification endpoint, use an using the client credentials grant type. OAuth 2.0 token, obtained using the client credentials grant type after mutually * TLS_CERT: Every HTTP request to the notification endpoint is sent authenticating using client identifier and X.509 certificates towards the token endpoint. over a mutually authenticated TLS session, i.e. not only the server is authenticated, but also the client is authenticated during the TLS tunnel setup. type: array type: array items: items: type: string type: string enum: enum: - BASIC - OAUTH2_CLIENT_CREDENTIALS - OAUTH2_CLIENT_CREDENTIALS - TLS_CERT - OAUTH2_CLIENT_CERT paramsBasic: paramsOauth2ClientCert: description: > description: > Parameters for authentication/authorization using BASIC. Parameters for authentication/authorization using Shall be present if authType is "BASIC" and the contained OAUTH2_CLIENT_CERT. Shall be present if authType is "OAUTH2_CLIENT_CERT" and the contained information has not been provisioned out of band. information has not been provisioned out of band. Shall be absent otherwise. Shall be absent otherwise. type: object type: object required: - clientId - certificateRef - tokenEndpoint properties: properties: userName: clientId: description: > description: > Username to be used in HTTP Basic authentication. Shall be Client identifier to be used in the access token request present if it has not been provisioned out of band. of the OAuth 2.0 client credentials grant type. The client identifier is unique in the scope of the tokenEndpoint. type: string type: string password: certificateRef: description: > description: > Password to be used in HTTP Basic authentication. Shall be Fingerprint of the client certificate. The hash function shall use SHA256 or higher. See note 4. present if it has not been provisioned out of band. type: string type: string required: - type - value properties: type: description: > The type of the fingerprint. Permitted values: - x5t#S256: The SHA-256 thumbprint of the X.509 certificate as defined in section 4.1.8 of IETF RFC 7515 [23]. $ref: "#/components/schemas/String" enum: - x5t#S256 value: description: > The fingerprint value as defined by the type. $ref: "#/components/schemas/String" tokenEndpoint: description: > The token endpoint from which the access token can be obtained. $ref: "#/components/schemas/Uri" paramsOauth2ClientCredentials: paramsOauth2ClientCredentials: description: > description: > Parameters for authentication/authorization using Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained contained information has not been provisioned out of band. information has not been provisioned out of band. Shall be absent otherwise. Shall be absent otherwise. See note 2. type: object type: object properties: properties: clientId: clientId: description: > description: > Client identifier to be used in the access token request of the Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. OAuth 2.0 client credentials grant type. The client identifier is unique in the scope of the tokenEndpoint. Shall be present if it has not been Shall be present if it has not been provisioned out of band. provisioned out of band. The clientId and clientPassword passed in a subscription shall See note 1. not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process. type: string type: string clientPassword: clientPassword: description: > description: > Client password to be used in the access token request of the Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. See note 1. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process. type: string type: string tokenEndpoint: tokenEndpoint: description: > description: > Loading Loading
src/SOL009/components/SOL009_schemas.yaml +73 −42 Original line number Original line Diff line number Diff line Loading @@ -216,6 +216,19 @@ components: - objectId - objectId SubscriptionAuthentication: SubscriptionAuthentication: description: > * NOTE 1 : The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process. * NOTE 2: As a less secure alternative to OAUTH2_CLIENT_CERT which uses mutual authentication based on X.509 certificates, this mode which uses client password to authenticate may be used in the access token request toward the authorization server (as defined by IETF RFC 6749 [7]), only to support legacy implementations (version 3.4.1 or earlier version of the present document). See clause 8.1 for more details. * NOTE 3: The following values that were included up to version 3.4.1 of the present document have been removed: "BASIC" (to signal the use of the basic HTTP authentication) has been removed because it is insecure. "TLS_CERT" to signal an alternative non-token based authorization method using TLS certificates has been removed because the method is no longer supported. * NOTE 4: The client certificate is established by means outside the scope of the present document. type: object type: object required: required: - authType - authType Loading @@ -224,71 +237,89 @@ components: description: > description: > Defines the types of Authentication / Authorization which the API Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. consumer is willing to accept when receiving a notification. Permitted values: Permitted values (see note 3): * BASIC: In every HTTP request to the notification endpoint, use * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use HTTP Basic authentication with the client credentials. an OAuth 2.0 token, obtained using the client credentials grant type after authenticating * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the using client identifier and client password towards the token endpoint. notification endpoint, use an OAuth 2.0 Bearer token, obtained * OAUTH2_CLIENT_CERT: In every HTTP request to the notification endpoint, use an using the client credentials grant type. OAuth 2.0 token, obtained using the client credentials grant type after mutually * TLS_CERT: Every HTTP request to the notification endpoint is sent authenticating using client identifier and X.509 certificates towards the token endpoint. over a mutually authenticated TLS session, i.e. not only the server is authenticated, but also the client is authenticated during the TLS tunnel setup. type: array type: array items: items: type: string type: string enum: enum: - BASIC - OAUTH2_CLIENT_CREDENTIALS - OAUTH2_CLIENT_CREDENTIALS - TLS_CERT - OAUTH2_CLIENT_CERT paramsBasic: paramsOauth2ClientCert: description: > description: > Parameters for authentication/authorization using BASIC. Parameters for authentication/authorization using Shall be present if authType is "BASIC" and the contained OAUTH2_CLIENT_CERT. Shall be present if authType is "OAUTH2_CLIENT_CERT" and the contained information has not been provisioned out of band. information has not been provisioned out of band. Shall be absent otherwise. Shall be absent otherwise. type: object type: object required: - clientId - certificateRef - tokenEndpoint properties: properties: userName: clientId: description: > description: > Username to be used in HTTP Basic authentication. Shall be Client identifier to be used in the access token request present if it has not been provisioned out of band. of the OAuth 2.0 client credentials grant type. The client identifier is unique in the scope of the tokenEndpoint. type: string type: string password: certificateRef: description: > description: > Password to be used in HTTP Basic authentication. Shall be Fingerprint of the client certificate. The hash function shall use SHA256 or higher. See note 4. present if it has not been provisioned out of band. type: string type: string required: - type - value properties: type: description: > The type of the fingerprint. Permitted values: - x5t#S256: The SHA-256 thumbprint of the X.509 certificate as defined in section 4.1.8 of IETF RFC 7515 [23]. $ref: "#/components/schemas/String" enum: - x5t#S256 value: description: > The fingerprint value as defined by the type. $ref: "#/components/schemas/String" tokenEndpoint: description: > The token endpoint from which the access token can be obtained. $ref: "#/components/schemas/Uri" paramsOauth2ClientCredentials: paramsOauth2ClientCredentials: description: > description: > Parameters for authentication/authorization using Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained contained information has not been provisioned out of band. information has not been provisioned out of band. Shall be absent otherwise. Shall be absent otherwise. See note 2. type: object type: object properties: properties: clientId: clientId: description: > description: > Client identifier to be used in the access token request of the Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. OAuth 2.0 client credentials grant type. The client identifier is unique in the scope of the tokenEndpoint. Shall be present if it has not been Shall be present if it has not been provisioned out of band. provisioned out of band. The clientId and clientPassword passed in a subscription shall See note 1. not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process. type: string type: string clientPassword: clientPassword: description: > description: > Client password to be used in the access token request of the Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. See note 1. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process. type: string type: string tokenEndpoint: tokenEndpoint: description: > description: > Loading
