tapis-authenticator 0.1.1

REST API and web server providing authentication for a Tapis v3 instance.
Documentation 
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
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

# \TokensApi

All URIs are relative to *http://localhost:5000*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_token**](TokensApi.md#create_token) | **POST** /v3/oauth2/tokens | Generate a Tapis JWT
[**create_v2_token**](TokensApi.md#create_v2_token) | **POST** /v3/oauth2/v2/token | Create a v2 bearer token from a Tapis v3 JWT.
[**generate_device_code**](TokensApi.md#generate_device_code) | **POST** /v3/oauth2/device/code | Generate a device code.
[**revoke_token**](TokensApi.md#revoke_token) | **POST** /v3/oauth2/tokens/revoke | Revoke a token.



## create_token

> models::CreateToken201Response create_token(new_token)
Generate a Tapis JWT

Generate a Tapis JWT using some OAuth2 grant type. Typically, a request to this endpoint is the last step in the token generation process. The fields required in the request payload depend on the grant type being used (see details below).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**new_token** | [**NewToken**](NewToken.md) |  | [required] |

### Return type

[**models::CreateToken201Response**](create_token_201_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json, application/x-www-form-urlencoded
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_v2_token

> models::CreateV2Token200Response create_v2_token(v2_token)
Create a v2 bearer token from a Tapis v3 JWT.

Create a v2 token from a Tapis v3 JWT. Note that only some tenants for both v2 and v3 are supported.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**v2_token** | [**V2Token**](V2Token.md) |  | [required] |

### Return type

[**models::CreateV2Token200Response**](create_v2_token_200_response.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## generate_device_code

> models::GenerateDeviceCode200Response generate_device_code(new_device_code)
Generate a device code.

Generate a device code; this is the first step in the device_code grant type. See the OAuth2 documentation for details.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**new_device_code** | [**NewDeviceCode**](NewDeviceCode.md) |  | [required] |

### Return type

[**models::GenerateDeviceCode200Response**](generate_device_code_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## revoke_token

> models::BasicResponse revoke_token(revoke_token_request)
Revoke a token.

Revoke a Tapis JWT. Pass the token to revoke in the body of the request. Once revoked, a token cannot be unrevoked. Only user tokens generated by this Authenticator can be revoked with this endpoint.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**revoke_token_request** | [**RevokeTokenRequest**](RevokeTokenRequest.md) |  | [required] |

### Return type

[**models::BasicResponse**](BasicResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)