Get authentication guidance
pc_auth_guidanceGet offline authentication guidance for Partner Center tokens by token flavor and national cloud, covering token resource, authority, Secure Application Model, MFA, and deprecated patterns.
Instructions
Return how to authenticate against Partner Center for a given token flavour and national cloud: the token resource and authority to use, the ordered steps of the flow, Secure Application Model and MFA requirements, and what is deprecated. Use this when deciding or setting up how to get a token. To check whether existing code already uses a retired pattern, use pc_check_auth instead; to decode a 401/403 you already hit, use pc_decode_error. Read-only, offline, deterministic. Returns guidance only — it issues no tokens, contacts no identity provider, and handles no secrets.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cloud | No | Sovereign cloud whose endpoints and authority to return. Defaults to "commercial". Choose "china-21vianet" or "us-gov" only for tenants in those clouds — their authorities and feature availability differ. | |
| authType | Yes | Which token flavour to describe. "app+user" is the Secure Application Model refresh-token flow required by most Partner Center operations; "app-only" is application permissions, which only a subset of endpoints accept. Required — check a scenario's authType with pc_get_scenario if unsure. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | True when the call succeeded and `data` is populated; false when `error` explains why not. | |
| data | No | The result payload. Present only when `ok` is true. | |
| error | No | Human-readable reason the call failed. Present only when `ok` is false. | |
| suggestions | No | Valid values to retry with, returned alongside `error` when the requested identifier was not found. |