IDaaS Open Platform
Employee Identity (EIAM)

Agreement Configuration

During the invocation of the agreement configuration interface, different results are returned based on the configuration. A successful normal call returns the agreement configuration information; if no agreement is configured, an empty array is returned.

# Request Description

GET https://{your_domain}/api/v2/sdk/agreement-config

# Request Headers

Parameter Name Chinese Name Required Type Example
X-operating-sys-version Calling client operating system version No String windows10.1.1
X-device-fingerprint Calling client device fingerprint No String 156aysdna213sc50
X-device-ip Calling client IP No String 192.168.1.2
X-agent User-Agent information No String Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X)
X-L Used for internationalization language setting No String zh
X-client-id Application authorization ID No String nTo1eRIub60vPb54WeE6aojPwYwImtl4
content-type Content format type Yes String application/json

# Return Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "code": "0",
    "data": [
        {
            "id": "20231213172230071-656B-DC5398451",
            "text": {
                "en": {
                    "context": "I have read and agree to the {20231214153403735-0EB3-72CE8BDC0} and {20231214153403729-2452-986A407AA}",
                    "agreements": [
                        {
                            "id": "20231214153403735-0EB3-72CE8BDC0",
                            "name": "23",
                            "type": "URL",
                            "context": "https://XXX"
                        },
                        {
                            "id": "20231214153403729-2452-986A407AA",
                            "name": "12",
                            "type": "URL",
                            "context": "https://XXX"
                        }
                    ]
                },
                "zh": {
                    "context": "我已阅读并同意{20231214153403717-76A1-31234B44F}和{20231214153403713-DA60-2201131A6}",
                    "agreements": [
                        {
                            "id": "20231214153403717-76A1-31234B44F",
                            "name": "2",
                            "type": "URL",
                            "context": "https://XXX"
                        },
                        {
                            "id": "20231214153403713-DA60-2201131A6",
                            "name": "1",
                            "type": "URL",
                            "context": "https://XXX"
                        }
                    ]
                }
            }
        }
    ],
    "message": null
}

Error Example:
None
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

# Return Parameter data is the agreement configuration list. The list parameter content:

Parameter Name Chinese Name Type
id Agreement Configuration ID String
text Agreement body in the configuration Object
text.context Content within the agreement body String
text.agreements Agreements within the agreement body Object
text.agreements.id Agreement ID String
text.agreements.name Agreement Name String
text.agreements.type Agreement Type String
text.agreements.context Content corresponding to the agreement type String

# Error Codes {/examples/}

Status Code Error Code Error Message Action
400 IDAAS.SDK.PARAM.0001 Device information is incomplete Please check if the input device information is complete
Device information is incomplete

Agreement Sign