跳转至

tenant_access_token

feishu.auth.tenant_access_token

get_tenant_access_token

Python
get_tenant_access_token(app_id: str, app_secret: str, timeout: int = 120) -> FlatDict
Python
get_tenant_access_token(app_access_token: str, tenant_key: str, timeout: int = 120) -> FlatDict
Python
get_tenant_access_token(input_a: str, input_b: str, timeout: int = 120) -> FlatDict

获取租户访问凭证

这是一个通用函数，根据传入的参数自动判断是自建应用还是商店应用，并调用相应的函数。

Parameters:

Name Type Description Default

input_a

str

应用唯一标识（对于自建应用，以cli_开头）或者应用访问凭证（对于商店应用，以a-开头）

 required

input_b

str

应用秘钥（对于自建应用）或者租户在飞书上的唯一标识（对于商店应用）

 required

timeout

int

超时时间。默认为 120 秒。

 120

Returns:

Type Description
FlatDict

租户访问凭证
飞书文档

通用参数介绍

功能 实现函数
获取自建应用的租户访问凭证 [feishu.auth.app_access_token.get_tenant_access_token_internal][]
获取商店应用的租户访问凭证 [feishu.auth.app_access_token.get_tenant_access_token_store][]

Examples:

Python Console Session
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
>>> get_tenant_access_token("cli_slkdjalasdkjasd", "dskLLdkasdjlasdKK")
FlatDict(
  ('code'): 0
  ('msg'): 'ok'
  ('tenant_access_token'): 't-g1044ghJRUIJJ5ZPPZMOHKWZISL33E4QSS3abcef'
  ('expire'): 7200
)
>>> get_tenant_access_token("a-32bd8551db2f081cbfd26293f27516390b9feb04", "73658811060f175d")
FlatDict(
  ('code'): 0
  ('msg'): 'success'
  ('tenant_access_token'): 't-caecc734c2e3328a62489fe0648c4b98779515d3'
  ('expire'): 7200
)
Source code in feishu/auth/tenant_access_token.py
Python
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def get_tenant_access_token(input_a: str, input_b: str, timeout: int = 120) -> FlatDict:  # type: ignore[misc]
    r"""
    获取租户访问凭证

    这是一个通用函数，根据传入的参数自动判断是自建应用还是商店应用，并调用相应的函数。

    Args:
        input_a: 应用唯一标识（对于自建应用，以`cli_`开头）或者应用访问凭证（对于商店应用，以`a-`开头）
        input_b: 应用秘钥（对于自建应用）或者租户在飞书上的唯一标识（对于商店应用）
        timeout: 超时时间。默认为 120 秒。

    Returns:
        租户访问凭证

    飞书文档:
        [通用参数介绍](https://open.feishu.cn/document/server-docs/api-call-guide/terminology)

    | 功能            | 实现函数                                                              |
    |---------------|-------------------------------------------------------------------|
    | 获取自建应用的租户访问凭证 | [feishu.auth.app_access_token.get_tenant_access_token_internal][] |
    | 获取商店应用的租户访问凭证 | [feishu.auth.app_access_token.get_tenant_access_token_store][]    |

    Examples:
        >>> get_tenant_access_token("cli_slkdjalasdkjasd", "dskLLdkasdjlasdKK")  # doctest:+SKIP
        FlatDict(
          ('code'): 0
          ('msg'): 'ok'
          ('tenant_access_token'): 't-g1044ghJRUIJJ5ZPPZMOHKWZISL33E4QSS3abcef'
          ('expire'): 7200
        )
        >>> get_tenant_access_token("a-32bd8551db2f081cbfd26293f27516390b9feb04", "73658811060f175d")  # doctest:+SKIP
        FlatDict(
          ('code'): 0
          ('msg'): 'success'
          ('tenant_access_token'): 't-caecc734c2e3328a62489fe0648c4b98779515d3'
          ('expire'): 7200
        )
    """
    if input_a.startswith("cli_"):
        return get_tenant_access_token_internal(input_a, input_b, timeout)
    if input_a.startswith("a-"):
        return get_tenant_access_token_store(input_a, input_b, timeout)
    raise ValueError("Invalid Request Parameters")

get_tenant_access_token_internal

Python
get_tenant_access_token_internal(app_id: str, app_secret: str, timeout: int = 120) -> FlatDict

自建应用获取租户访问凭证

Parameters:

Name Type Description Default

app_id

str

应用唯一标识（以cli_开头）

 required

app_secret

str

应用秘钥

 required

timeout

int

超时时间。默认为 120 秒。

 120

Returns:

Type Description
FlatDict

租户访问凭证
飞书文档

通用参数介绍

自建应用获取租户访问凭证

Examples:

Python Console Session
1
2
3
4
5
6
7
>>> get_tenant_access_token_internal("cli_slkdjalasdkjasd", "dskLLdkasdjlasdKK")
FlatDict(
  ('code'): 0
  ('msg'): 'ok'
  ('tenant_access_token'): 't-g1044ghJRUIJJ5ZPPZMOHKWZISL33E4QSS3abcef'
  ('expire'): 7200
)
Source code in feishu/auth/tenant_access_token.py
Python
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
def get_tenant_access_token_internal(app_id: str, app_secret: str, timeout: int = 120) -> FlatDict:
    r"""
    自建应用获取租户访问凭证

    Args:
        app_id: 应用唯一标识（以`cli_`开头）
        app_secret: 应用秘钥
        timeout: 超时时间。默认为 120 秒。

    Returns:
        租户访问凭证

    飞书文档:
        [通用参数介绍](https://open.feishu.cn/document/server-docs/api-call-guide/terminology)

        [自建应用获取租户访问凭证](https://open.feishu.cn/document/server-docs/authentication-management/access-token/tenant_access_token_internal)

    Examples:
        >>> get_tenant_access_token_internal("cli_slkdjalasdkjasd", "dskLLdkasdjlasdKK")  # doctest:+SKIP
        FlatDict(
          ('code'): 0
          ('msg'): 'ok'
          ('tenant_access_token'): 't-g1044ghJRUIJJ5ZPPZMOHKWZISL33E4QSS3abcef'
          ('expire'): 7200
        )
    """
    url = variables.BASE_URL + "auth/v3/tenant_access_token/internal"
    data = {"app_id": app_id, "app_secret": app_secret}
    response = httpx.post(url, json=data, timeout=timeout)
    if response.status_code != 200:
        raise FeishuException(response.status_code, response.text)
    ret = response.json()
    if ret.get("code") != 0:
        raise FeishuException(ret.get("code"), ret.get("msg"))
    return FlatDict(ret)

get_tenant_access_token_store

Python
get_tenant_access_token_store(app_access_token: str, tenant_key: str, timeout: int = 120) -> FlatDict

商店应用获取租户访问凭证

Parameters:

Name Type Description Default

app_access_token

str

应用访问凭证（以a-开头）

 required

tenant_key

str

租户在飞书上的唯一标识

 required

timeout

int

超时时间。默认为 120 秒。

 120

Returns:

Type Description
FlatDict

租户访问凭证
飞书文档

通用参数介绍

商店应用获取租户访问凭证

Examples:

Python Console Session
1
2
3
4
5
6
7
>>> get_tenant_access_token_store("a-32bd8551db2f081cbfd26293f27516390b9feb04", "73658811060f175d")
FlatDict(
  ('code'): 0
  ('msg'): 'success'
  ('tenant_access_token'): 't-caecc734c2e3328a62489fe0648c4b98779515d3'
  ('expire'): 7200
)
Source code in feishu/auth/tenant_access_token.py
Python
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
def get_tenant_access_token_store(app_access_token: str, tenant_key: str, timeout: int = 120) -> FlatDict:
    r"""
    商店应用获取租户访问凭证

    Args:
        app_access_token: 应用访问凭证（以`a-`开头）
        tenant_key: 租户在飞书上的唯一标识
        timeout: 超时时间。默认为 120 秒。

    Returns:
        租户访问凭证

    飞书文档:
        [通用参数介绍](https://open.feishu.cn/document/server-docs/api-call-guide/terminology)

        [商店应用获取租户访问凭证](https://open.feishu.cn/document/server-docs/authentication-management/access-token/tenant_access_token)

    Examples:
        >>> get_tenant_access_token_store("a-32bd8551db2f081cbfd26293f27516390b9feb04", "73658811060f175d")  # doctest:+SKIP
        FlatDict(
          ('code'): 0
          ('msg'): 'success'
          ('tenant_access_token'): 't-caecc734c2e3328a62489fe0648c4b98779515d3'
          ('expire'): 7200
        )
    """  # noqa: E501
    url = variables.BASE_URL + "auth/v3/tenant_access_token"
    data = {"app_access_token": app_access_token, "tenant_key": tenant_key}
    response = httpx.post(url, json=data, timeout=timeout)
    if response.status_code != 200:
        raise FeishuException(response.status_code, response.text)
    ret = response.json()
    if ret.get("code") != 0:
        raise FeishuException(ret.get("code"), ret.get("msg"))
    return FlatDict(ret)