All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| MemberDelete | Delete /accounts/{account_id}/members/{id} | Remove a user from the account |
| MemberShow | Get /accounts/{account_id}/members/{id} | Get single member |
| MemberUpdate | Patch /accounts/{account_id}/members/{id} | Update a member |
| MemberUpdateSettings | Patch /projects/{project_id}/members/{id} | Update a member's project settings |
| MembersList | Get /accounts/{account_id}/members | List members |
MemberDelete(ctx, accountId, id, optional)
Remove a user from the account
Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include team.manage.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *MemberDeleteOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MemberDeleteOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Member MemberShow(ctx, accountId, id, optional)
Get single member
Get details on a single user in the account. Access token scope must include team.manage.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *MemberShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MemberShowOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Member MemberUpdate(ctx, accountId, id, memberUpdateParameters, optional)
Update a member
Update user permissions in the account. Developers and translators need project_ids and locale_ids assigned to access them. Access token scope must include team.manage.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| memberUpdateParameters | MemberUpdateParameters | ||
| optional | *MemberUpdateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MemberUpdateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MemberProjectDetail MemberUpdateSettings(ctx, projectId, id, memberUpdateSettingsParameters, optional)
Update a member's project settings
Update user settings in the project. Access token scope must include team.manage.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | ID | |
| memberUpdateSettingsParameters | MemberUpdateSettingsParameters | ||
| optional | *MemberUpdateSettingsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MemberUpdateSettingsOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Member MembersList(ctx, accountId, optional)
List members
Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include team.manage.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| optional | *MembersListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a MembersListOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | page | optional.Int32| Page number | perPage | optional.Int32| Limit on the number of objects to be returned, between 1 and 100. 25 by default |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]