Skip to content

Latest commit

 

History

History
209 lines (130 loc) · 6.79 KB

SCIMApi.md

File metadata and controls

209 lines (130 loc) · 6.79 KB
Raw

{{classname}}

All URIs are relative to https://app.harness.io/gateway

Method HTTP request Description
CreateUser Post /ng/api/scim/account/{accountIdentifier}/Users
DeleteUser Delete /ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
GetUser Get /ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
SearchUser Get /ng/api/scim/account/{accountIdentifier}/Users
UpdateUser Patch /ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
UpdateUser1 Put /ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}

CreateUser

CreateUser(ctx, accountIdentifier, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountIdentifier string
optional *SCIMApiCreateUserOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SCIMApiCreateUserOpts struct

Name Type Description Notes

body | optional.Interface of ScimUser| |

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/scim+json, application/json
  • Accept: application/json, application/yaml

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

DeleteUser

DeleteUser(ctx, userIdentifier, accountIdentifier)

Required Parameters

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

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

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

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

GetUser

GetUser(ctx, userIdentifier, accountIdentifier)

Required Parameters

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

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

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

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

SearchUser

SearchUser(ctx, accountIdentifier, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountIdentifier string
optional *SCIMApiSearchUserOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SCIMApiSearchUserOpts struct

Name Type Description Notes

filter | optional.String| | count | optional.Int32| | startIndex | optional.Int32| |

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

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

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

UpdateUser

UpdateUser(ctx, accountIdentifier, userIdentifier, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountIdentifier string
userIdentifier string
optional *SCIMApiUpdateUserOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SCIMApiUpdateUserOpts struct

Name Type Description Notes

body | optional.Interface of PatchRequest| |

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/scim+json, application/json
  • Accept: application/json, application/yaml

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

UpdateUser1

UpdateUser1(ctx, userIdentifier, accountIdentifier, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userIdentifier string
accountIdentifier string
optional *SCIMApiUpdateUser1Opts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SCIMApiUpdateUser1Opts struct

Name Type Description Notes

body | optional.Interface of ScimUser| |

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/scim+json, application/json
  • Accept: application/json, application/yaml

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