Get a user authentication method
GET/projectProfiles/{publicAlias}/userAuthMethods/{methodId}
Base URL: https://api.tinkermode.com
Get the specified alternative user authentication method.
Authentication
This endpoint does not require authentication.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
publicAlias | string | Yes | A unique identifier to look up a profile's public profile. | |
methodId | string | Yes | Identifier of authentication method |
Responses
200 Authentication method is returned.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
config | object | No | Configuration key-value pairs, whose specific structure depends on the protocol of this method. This field is only present to authorized administrators. | |
description | string | No | Additional info about this method. | |
iconUrl | string | No | URL to an icon image to represent this method on UI. | |
id | string | Yes | read-only (server-generated) | Identifier assigned to the method. |
label | string | Yes | String to be displayed on UI to represent this method. | |
protocol | string | Yes | one of: oidc | The protocol to be used with this method. |
401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
404 The requested userAuthMethod does not exist or is not accessible.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |