lcm/ns/serializers/sol/subscription_auth_data.py

   1 # Copyright (c) 2019, CMCC Technologies Co., Ltd.
   2
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15
  16 from rest_framework import serializers
  17
  18 from lcm.ns import const
  19
  20
  21 class OAuthCredentialsSerializer(serializers.Serializer):
  22     clientId = serializers.CharField(
  23         help_text="Client identifier to be used in the access token request of the OAuth 2.0 client "
  24                   "credentials grant type.", required=False, max_length=255, allow_null=False)
  25     clientPassword = serializers.CharField(
  26         help_text="Client password to be used in the access token request of the OAuth 2.0 client"
  27                   " credentials grant type.", required=False, max_length=255, allow_null=False)
  28     tokenEndpoint = serializers.CharField(
  29         help_text="The token endpoint from which the access token can be obtained.", required=False,
  30         max_length=255,
  31         allow_null=False)
  32
  33
  34 class BasicAuthSerializer(serializers.Serializer):
  35     userName = serializers.CharField(
  36         help_text="Username to be used in HTTP Basic authentication.", max_length=255,
  37         required=False,
  38         allow_null=False)
  39     password = serializers.CharField(
  40         help_text="Password to be used in HTTP Basic authentication.", max_length=255,
  41         required=False,
  42         allow_null=False)
  43
  44
  45 class SubscriptionAuthenticationSerializer(serializers.Serializer):
  46     authType = serializers.ListField(
  47         child=serializers.ChoiceField(required=True, choices=const.AUTH_TYPES),
  48         help_text="Defines the types of Authentication / Authorization which the API consumer is"
  49                   " willing to accept when receiving a notification.", required=True)
  50     paramsBasic = BasicAuthSerializer(
  51         help_text="Parameters for authentication/authorization using BASIC.",
  52         required=False,
  53         allow_null=False)
  54     paramsOauth2ClientCredentials = OAuthCredentialsSerializer(
  55         help_text="Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.",
  56         required=False,
  57         allow_null=False)