@terrane/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @terrane/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to /api/sentinel/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DefaultApi | authCheckMembershipPost | POST /auth/check-membership | Check user membership in groups and organizations DefaultApi | authCheckTokenGet | GET /auth/check-token | Check token validity DefaultApi | authIntrospectPost | POST /auth/introspect | Introspect a token (RFC 7662) DefaultApi | authLoginPost | POST /auth/login | Log in to the system DefaultApi | authLogoutPost | POST /auth/logout | Log out from the system DefaultApi | authProvidersGet | GET /auth/providers | List all OIDC providers DefaultApi | authProvidersPost | POST /auth/providers | Create a new OIDC provider configuration DefaultApi | authProvidersProviderIDGet | GET /auth/providers/{providerID} | Retrieve an OIDC provider configuration DefaultApi | authProvidersProviderIDPatch | PATCH /auth/providers/{providerID} | Edit the discovery document values for an existing OIDC provider DefaultApi | authProvidersPublicGet | GET /auth/providers/public | Get Public List of Auth Providers DefaultApi | authRefreshPost | POST /auth/refresh | Refresh access token DefaultApi | authRevokePost | POST /auth/revoke | Revoke a token (RFC 7009) DefaultApi | billingAccountsAccountIdDelete | DELETE /billing/accounts/{accountId} | Cancel a billing account DefaultApi | billingAccountsAccountIdGet | GET /billing/accounts/{accountId} | Get a billing account DefaultApi | billingAccountsAccountIdMembersGet | GET /billing/accounts/{accountId}/members | List billing account members DefaultApi | billingAccountsAccountIdMembersPost | POST /billing/accounts/{accountId}/members | Add a member to a billing account DefaultApi | billingAccountsAccountIdMembersPrincipalIdDelete | DELETE /billing/accounts/{accountId}/members/{principalId} | Remove a member from a billing account DefaultApi | billingAccountsAccountIdMembersPrincipalIdPatch | PATCH /billing/accounts/{accountId}/members/{principalId} | Update a member's role DefaultApi | billingAccountsAccountIdPatch | PATCH /billing/accounts/{accountId} | Update a billing account DefaultApi | billingAccountsGet | GET /billing/accounts | List billing accounts DefaultApi | billingAccountsPost | POST /billing/accounts | Create a billing account DefaultApi | checkScopesGet | GET /check-scopes | Check multiple scopes for a principal DefaultApi | createProjectPermission | POST /project-permissions | Grant a permission on a project DefaultApi | deleteProjectPermission | DELETE /project-permissions/{projectRid}/{principalRid} | Revoke a permission on a project DefaultApi | groupsGet | GET /groups | List all groups DefaultApi | groupsGroupIdScopesGet | GET /groups/{groupId}/scopes | List scopes assigned to a group DefaultApi | groupsGroupIdScopesPost | POST /groups/{groupId}/scopes | Add scopes to a group DefaultApi | groupsGroupIdUsersDelete | DELETE /groups/{groupId}/users | Remove a user from a group DefaultApi | groupsGroupIdUsersGet | GET /groups/{groupId}/users | List users in a group DefaultApi | groupsGroupIdUsersPost | POST /groups/{groupId}/users | Add a user to a group DefaultApi | groupsPost | POST /groups | Create a new group DefaultApi | listProjectPermissions | GET /project-permissions/{projectRid} | List permissions for a project DefaultApi | oauthClientsGet | GET /oauth/clients | List registered OAuth clients DefaultApi | oauthClientsPost | POST /oauth/clients | Register an OAuth 2.0 client DefaultApi | oauthTokenPost | POST /oauth/token | OAuth 2.0 token endpoint (RFC 6749) DefaultApi | organizationsGet | GET /organizations | List all organizations DefaultApi | organizationsOrganizationIdDefaultBillingAccountGet | GET /organizations/{organizationId}/default-billing-account | Get the org's default billing account DefaultApi | organizationsOrganizationIdDefaultBillingAccountPatch | PATCH /organizations/{organizationId}/default-billing-account | Set the org's default billing account DefaultApi | organizationsOrganizationIdGet | GET /organizations/{organizationId} | Get an organization by ID DefaultApi | organizationsOrganizationIdUsersGet | GET /organizations/{organizationId}/users | List users in an organization DefaultApi | organizationsOrganizationIdUsersPost | POST /organizations/{organizationId}/users | Add a user to an organization DefaultApi | organizationsPost | POST /organizations | Create a new organization DefaultApi | principalsGetbyidsGet | GET /principals/getbyids/ | Get principals by a list of IDs DefaultApi | principalsPrincipalIdGet | GET /principals/{principal_id} | Get associated users and groups DefaultApi | principalsSearchGet | GET /principals/search/ | Search principals by text query DefaultApi | principalsSearchIdsGet | GET /principals/search-ids/ | Search principals by text query DefaultApi | scopesGet | GET /scopes | List all available scopes DefaultApi | scopesPost | POST /scopes | Assign a scope on a resource to a principal DefaultApi | secretsApitokenGeneratePost | POST /secrets/apitoken/generate | Generate a scoped API token on behalf of a user DefaultApi | secretsGet | GET /secrets | List all secrets DefaultApi | secretsPost | POST /secrets | Create a new secret DefaultApi | secretsSecretIDDelete | DELETE /secrets/{secretID} | Delete a secret DefaultApi | secretsSecretIDGet | GET /secrets/{secretID} | Retrieve secret details DefaultApi | secretsSecretIDInvalidatePut | PUT /secrets/{secretID}/invalidate | Invalidate a secret DefaultApi | secretsSecretIDPut | PUT /secrets/{secretID} | Update a secret DefaultApi | secretsSecretIDRetrieveGet | GET /secrets/{secretID}/retrieve | Securely retrieve a secret's plaintext value DefaultApi | usersGet | GET /users | List all users DefaultApi | usersMeGet | GET /users/me | Get current user profile DefaultApi | usersPost | POST /users | Create a new user DefaultApi | usersUserIdDelete | DELETE /users/{userId} | Delete a user DefaultApi | usersUserIdEffectiveScopesGet | GET /users/{userId}/effective-scopes | Get the union of direct scopes and all inherited group scopes DefaultApi | usersUserIdGet | GET /users/{userId} | Get a user by ID DefaultApi | usersUserIdGroupsGet | GET /users/{userId}/groups | List groups a user belongs to DefaultApi | usersUserIdPatch | PATCH /users/{userId} | Update a user DefaultApi | usersUserIdScopesGet | GET /users/{userId}/scopes | List scopes directly assigned to a user DefaultApi | usersUserIdScopesPost | POST /users/{userId}/scopes | Add scopes to a user OIDCApi | authProviderAuthorizeGet | GET /auth/{provider}/authorize | Authorization Endpoint (Multi-Provider) OIDCApi | authProviderCallbackGet | GET /auth/{provider}/callback | OIDC Callback Handler (Multi‑Provider) OIDCApi | authProviderJwksJsonGet | GET /auth/{provider}/jwks.json | JWKS Endpoint (Multi-Provider) OIDCApi | authProviderTokenPost | POST /auth/{provider}/token | Token Endpoint (Multi-Provider) OIDCApi | authProviderUserinfoGet | GET /auth/{provider}/userinfo | UserInfo Endpoint (Multi-Provider) OIDCApi | authProviderWellKnownOpenidConfigurationGet | GET /auth/{provider}/.well-known/openid-configuration | OpenID Connect Discovery Endpoint (Multi-Provider)

Documentation For Models

• AddUserToGroupRequest
• AuthCheckMembershipPost200Response
• AuthCheckMembershipPostRequest
• AuthLoginRequest
• AuthLoginResponse
• AuthProviderJwksJsonGet200Response
• AuthProviderJwksJsonGet200ResponseKeysInner
• AuthProviderTokenPost200Response
• AuthProviderTokenPost200Response1
• AuthProviderUserinfoGet200Response
• AuthProviderWellKnownOpenidConfigurationGet200Response
• AuthProvidersPublicGet200ResponseInner
• AuthRefreshRequest
• AuthRevokePostRequest1
• BillingAccount
• BillingAccountsAccountIdMembersPostRequest
• BillingAccountsAccountIdMembersPrincipalIdPatchRequest
• BillingAccountsAccountIdPatchRequest
• BillingAccountsPostRequest
• BillingMembership
• ErrorResponse
• Group
• GroupSummary
• OAuthClient
• OAuthClientCreate
• OAuthClientWithSecret
• OAuthErrorResponse
• OAuthTokenResponse
• OIDCProvider
• OidcProviderEditDiscoveryRequest
• OidcProviderPostRequest
• Organization
• OrganizationSummary
• OrganizationsOrganizationIdDefaultBillingAccountPatchRequest
• OrganizationsOrganizationIdUsersPostRequest
• PaginatedGroupResponse
• PaginatedOrganizationResponse
• PaginatedPrincipalResponse
• PaginatedPrincipalResponseItemsInner
• PaginatedUserResponse
• ProjectPermission
• ProjectPermissionCreate
• ProjectPermissionPage
• RemoveUserFromGroupRequest
• ResourceScope
• ResourceScopeCreate
• Scope
• ScopeCheckResult
• ScopeCreate
• Secret
• SecretsApitokenGeneratePost201Response
• SecretsApitokenGeneratePostRequest
• SecretsPostRequest
• SecretsSecretIDPutRequest
• SecretsSecretIDRetrieveGet200Response
• TokenIntrospectionResponse
• User
• UserSsoInfo
• UserSummary
• UsersPostRequest
• UsersUserIdScopesPostRequest

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)