Skip to content

Latest commit

 

History

History
533 lines (315 loc) · 14.7 KB

AuthApi.md

File metadata and controls

533 lines (315 loc) · 14.7 KB
Raw

\AuthApi

All URIs are relative to http://localhost

Method HTTP request Description
AssignRoleToGroup Post /1.9/roles/{role_name}/group
AssignRoleToToken Post /1.6/roles/{role_name}/token
CreateRole Post /1.0/roles
DefaultRoleAdd Post /1.0/role/default
DeleteRole Delete /1.0/roles/{role_name}
DissociateRole Delete /1.0/roles/{role_name}/user/{email}
DissociateRoleFromGroup Delete /1.6/roles/{role_name}/group/{group_name}
DissociateRoleFromToken Delete /1.6/roles/{role_name}/token/{token_id}
PermissionAdd Post /1.0/roles/{role_name}/permissions
RemovePermission Delete /1.0/roles{role_name}/permissions/{permission}
RoleAssign Post /1,0/roles/{role_name}/user
RoleDefaultDelete Delete /1.0/role/default
TeamTokenCreate Post /1.6/tokens
TeamTokenDelete Delete /1.6/tokens/{token_id}
TeamTokenInfo Get /1.7/tokens/{token_id}
TeamTokenUpdate Put /1.6/tokens/{token_id}
TeamTokensList Get /1.6/tokens
UpdateRole Put /1.0/roles

AssignRoleToGroup

AssignRoleToGroup(ctx, roleName, assignGroupArgs)

Assigns a role to a group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleName string
assignGroupArgs AssignGroupArgs

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AssignRoleToToken

AssignRoleToToken(ctx, roleName, assignTokenArgs)

Assigns a role to a team token.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleName string
assignTokenArgs AssignTokenArgs

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateRole

CreateRole(ctx, roleAddData)

create a role

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleAddData RoleAddData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DefaultRoleAdd

DefaultRoleAdd(ctx, roleDefaultData)

add a default role

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleDefaultData RoleDefaultData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteRole

DeleteRole(ctx, roleName)

delete a role

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleName string

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DissociateRole

DissociateRole(ctx, roleName, email)

Dissociate a role from user

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleName string
email string

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DissociateRoleFromGroup

DissociateRoleFromGroup(ctx, roleName, groupName, context)

Dissociates a role from a group.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleName string
groupName string
context string

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DissociateRoleFromToken

DissociateRoleFromToken(ctx, roleName, tokenId, context)

Dissociates a role from a team token.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleName string
tokenId string
context string

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PermissionAdd

PermissionAdd(ctx, roleName, permissionData)

add a permission

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleName string
permissionData PermissionData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemovePermission

RemovePermission(ctx, roleName, permission)

remove a permission

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleName string
permission string

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RoleAssign

RoleAssign(ctx, roleName, roleAssignData)

assign a role

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleName string
roleAssignData RoleAssignData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RoleDefaultDelete

RoleDefaultDelete(ctx, )

Delete a Default role

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamTokenCreate

TeamToken TeamTokenCreate(ctx, teamTokenCreateArgs)

Creates a team token.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamTokenCreateArgs TeamTokenCreateArgs

Return type

TeamToken

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamTokenDelete

TeamTokenDelete(ctx, tokenId)

Deletes a team token.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
tokenId string Token ID.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamTokenInfo

TeamToken TeamTokenInfo(ctx, tokenId)

Shows information about a specific token.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
tokenId string Token ID.

Return type

TeamToken

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamTokenUpdate

TeamToken TeamTokenUpdate(ctx, tokenId, teamTokenUpdateArgs)

Updates a team token.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
tokenId string Token ID.
teamTokenUpdateArgs TeamTokenUpdateArgs

Return type

TeamToken

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamTokensList

[]TeamToken TeamTokensList(ctx, )

List team tokens.

Required Parameters

This endpoint does not need any parameter.

Return type

[]TeamToken

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateRole

UpdateRole(ctx, roleUpdateData)

update a role

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
roleUpdateData RoleUpdateData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]