Skip to content

Commit ede25a6

Browse files
committed
updates
1 parent 4d9296f commit ede25a6

4 files changed

Lines changed: 9 additions & 15 deletions

File tree

src/admin-portal/interfaces/generate-link.interface.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ export interface GenerateLink {
2727
intent?: GenerateLinkIntent;
2828
/** Options to configure the Admin Portal based on the intent. */
2929
intentOptions?: IntentOptions;
30+
/** The email addresses of the IT admins to grant access to the Admin Portal for the given organization. Accepts up to 20 emails. */
31+
adminEmails?: string[];
3032
}
3133

3234
export interface GenerateLinkResponse {
@@ -35,4 +37,5 @@ export interface GenerateLinkResponse {
3537
organization: string;
3638
intent?: GenerateLinkIntent;
3739
intent_options?: IntentOptionsResponse;
40+
admin_emails?: string[];
3841
}

src/authorization/authorization.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -731,14 +731,15 @@ export class Authorization {
731731
}
732732

733733
/**
734-
* Assign a role
734+
* List role assignments
735735
*
736-
* Assign a role to an organization membership on a specific resource.
737-
* @param payload - Object containing roleSlug.
738-
* @returns {Promise<RoleAssignment>}
736+
* List all role assignments for an organization membership. This returns all roles that have been assigned to the user on resources, including organization-level and sub-resource roles.
737+
* @param organizationMembershipId - The ID of the organization membership.
738+
* @example "om_01HXYZ123456789ABCDEFGHIJ"
739+
* @param options - Pagination and filter options.
740+
* @returns {Promise<AutoPaginatable<RoleAssignment>>}
739741
* @throws {AuthorizationException} 403
740742
* @throws {NotFoundException} 404
741-
* @throws {UnprocessableEntityException} 422
742743
*/
743744
async listRoleAssignments(
744745
options: ListRoleAssignmentsOptions,

src/sso/sso.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,18 +81,12 @@ export class SSO {
8181
* @example ["openid","profile","email"]
8282
* @param options.providerQueryParams - Key/value pairs of query parameters to pass to the OAuth provider. Only applicable when using OAuth connections.
8383
* @example {"hd":"example.com","access_type":"offline"}
84-
* @param options.clientId - The unique identifier of the WorkOS environment client.
85-
* @example "client_01HZBC6N1EB1ZY7KG32X"
8684
* @param options.domain - (deprecated) Deprecated. Use `connection` or `organization` instead. Used to initiate SSO for a connection by domain. The domain must be associated with a connection in your WorkOS environment.
8785
* @example "example.com"
8886
* @param options.provider - Used to initiate OAuth authentication with Google, Microsoft, GitHub, or Apple.
8987
* @example "GoogleOAuth"
9088
* @param options.redirectUri - Where to redirect the user after they complete the authentication process. You must use one of the redirect URIs configured via the [Redirects](https://dashboard.workos.com/redirects) page on the dashboard.
9189
* @example "https://example.com/callback"
92-
* @param options.responseType - The only valid option for the response type parameter is `"code"`.
93-
*
94-
* The `"code"` parameter value initiates an [authorization code grant type](https://tools.ietf.org/html/rfc6749#section-4.1). This grant type allows you to exchange an authorization code for an access token during the redirect that takes place after a user has authenticated with an identity provider.
95-
* @example "code"
9690
* @param options.state - An optional parameter that can be used to encode arbitrary information to help restore application state between redirects. If included, the redirect URI received from WorkOS will contain the exact `state` that was passed.
9791
* @example "dj1kUXc0dzlXZ1hjUQ=="
9892
* @param options.connection - Used to initiate SSO for a connection. The value should be a WorkOS connection ID.

src/user-management/user-management.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1406,12 +1406,8 @@ export class UserManagement {
14061406
* @example "eyJyZXR1cm5UbyI6ICIvZGFzaGJvYXJkIn0="
14071407
* @param options.organizationId - The ID of the organization to authenticate the user against.
14081408
* @example "org_01EHQMYV6MBK39QC5PZXHY59C3"
1409-
* @param options.responseType - The response type of the application.
1410-
* @example "code"
14111409
* @param options.redirectUri - The callback URI where the authorization code will be sent after authentication.
14121410
* @example "https://example.com/callback"
1413-
* @param options.clientId - The unique identifier of the WorkOS environment client.
1414-
* @example "client_01HZBC6N1EB1ZY7KG32X"
14151411
* @param options - Additional query options.
14161412
* @returns {string}
14171413
*/

0 commit comments

Comments
 (0)