sdp-api-specification/claim_names.yml at main · appgate/sdp-api-specification · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
claim-names:
  get:
    summary: List all Claim Names.
    description: >-
      Claim Names list includes available User, Device and System claims.
      Some of these claims are static and some change according to the Identity Provider configurations.
    tags:
      - Conditions
    parameters:
      - $ref: './common.yml#/parameters/authorization'
    responses:
      '200':
        description: List of Claim Names.
        content:
          application/json:
            schema:
              $ref: '#/definitions/ClaimNamesList'
      '401':
        $ref: './common.yml#/responses/TokenError'
      '403':
        $ref: './common.yml#/responses/PermissionError'
      '500':
        $ref: './common.yml#/responses/UnexpectedError'


definitions:
  ClaimNamesList:
    type: object
    properties:
      user:
        $ref: '#/definitions/ClaimNames'
      device:
        $ref: '#/definitions/ClaimNames'
      system:
        $ref: '#/definitions/ClaimNames'
      onDemand:
        $ref: '#/definitions/ClaimNames'


  ClaimNames:
    type: array
    items:
      type: object
      description: Details of a Claim.
      properties:
        claimName:
          type: string
          description: Name of the Claim that's available to the JavaScript engine.
          example: username
        type:
          type: string
          description: Data type of the Claim.
          enum:
            - boolean
            - string
            - number
            - date
            - list
        availableForPolicy:
          type: boolean
          description: >-
            Whether the claim is available to Policy and Criteria Scripts or not.
            All Claims are available to Conditions and Entitlement Scripts.