Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitb3179b6

Browse files
authored
KB Articles to Docs - 25 July 2024 (#1023)
* combine 1 article and corrected 2* merge git clone and updated account invite* move user invite troubleshooting to docs* merge aquire git trigger information
1 parent0cd4407 commitb3179b6

File tree

8 files changed

+230
-305
lines changed

8 files changed

+230
-305
lines changed

‎_docs/administration/account-user-management/add-users.md‎

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,10 @@ toc: true
1313

1414
Once you have created a Codefresh account, you can add any number of users to collaborate on repositories, workflows, and pipelines, and teams of users. For Codefresh on-premises, see[On-premises account & user setup]({{site.baseurl}}/docs/installation/on-premises/on-prem-configuration/).
1515

16-
17-
1816
You can then create teams in Codefresh to group users who share a common denominator, such as the same permissions, access to the same functionality, or roles. Teams make it easy for administrators to both define and manage items shared by multiple users in an orgranization.
1917

20-
2118
##Users in Codefresh
19+
2220
Adding a user to an account requires assigning a role to define access to account resources, and optionally, selecting an SSO provider for the user:
2321

2422
***Role**: Defines the user's access level to the resources in the account.
@@ -28,39 +26,38 @@ on clusters, docker registries, git integrations, shared configurations etc.
2826
For guidelines on access control, see[Access control]({{site.baseurl}}/docs/administration/account-user-management/access-control/).
2927
***SSO**: By default, SSO is not enabled for users. If required, explicitly select the SSO provider. For an overview of SSO, see[Single Sign on]({{site.baseurl}}/docs/administration/single-sign-on/).
3028

29+
###Add a user to a Codefresh account
3130

32-
###Add a user to a Codefresh account
3331
1. In the Codefresh UI, on the toolbar, click the**Settings** icon and then select**Account Settings**.
34-
1. On the sidebar, from Access & Collaboration select[**Users & Teams**](https://g.codefresh.io/account-admin/collaborators/users){:target="\_blank"}.
32+
1. On the sidebar, from Access & Collaboration select[**Users & Teams**](https://g.codefresh.io/account-admin/collaborators/users){:target="\_blank"}.
3533
1. Select**Users**, and then select**+[Add User]**.
36-
1. Type the**User's email address**, and click**Invite**.
37-
<!---add screenshot-->
38-
The user receives an email invitation, and in the Users list, the username is set to Pending, and status to Resend.
39-
1. From the**Role** dropdown, select either**User** or**Administrator**.
34+
1. Type the**User's email address**, and click**Invite**.
35+
<!---add screenshot-->
36+
The user receives an email invitation, and in the Users list, the username is set to Pending, and status to Resend.
37+
1. From the**Role** dropdown, select either**User** or**Administrator**.
4038
1. If SSO is configured for the account,**Select SSO provider**.
4139

42-
43-
4440
###Manage users in a Codefresh account
4541

46-
Once you add a user to your Codefresh account, you can do the following to manage that user:
42+
Once you add a user to your Codefresh account, you can do the following to manage that user:
43+
4744
* Resend invitations that are pending acceptance: Select**Resend**.
4845
* Edit the user's email address: Select**Edit**.
4946
* Change the role: From the**Role** dropdown, select the new role.
5047
* Change SSO provider: From the**SSO** dropdown, select the new SSO provider.
5148
* Remove the user account: Select**Delete**.
5249

53-
54-
5550
##Teams in Codefresh
51+
5652
Teams are users who share the same permissions, roles, or requirements defined according to company processes. Teams allow you to enforce access control through ABAC (Attribute Based Access Control).
5753

5854
By default, there are two teams:
55+
5956
* Users
6057
* Admins with users[invited as collaborators](#assign-a-user-to-a-team)
6158

62-
>**NOTE**
63-
Only Enterprise customers can add new teams. Other Codefresh plans can only use the predefined*Users* and*Admin* teams.[Contact us](https://codefresh.io/contact-us/){:target="\_blank"} to upgrade to an Enterprise plan.
59+
>**NOTE**
60+
>Only Enterprise customers can add new teams. Other Codefresh plans can only use the predefined*Users* and*Admin* teams.[Contact us](https://codefresh.io/contact-us/){:target="\_blank"} to upgrade to an Enterprise plan.
6461
6562
###Automatically creating projects for teams
6663

@@ -69,13 +66,13 @@ As part of the global pipeline settings for an account, when creating a team, yo
6966
###Create a team in Codefresh
7067

7168
Create a team in Codefresh and then assign users to the team. You can assign the same user to multiple teams, as in most companies, users have overlapping roles.
72-
69+
7370
1. In the Codefresh UI, on the toolbar, click the**Settings** icon and then select**User Management**.
74-
1. From the sidebar, from Access & Collaboration, select[**Users & Teams**](https://g.codefresh.io/account-admin/collaborators/users){:target="\_blank"}.
71+
1. From the sidebar, from Access & Collaboration, select[**Users & Teams**](https://g.codefresh.io/account-admin/collaborators/users){:target="\_blank"}.
7572
1. Select**Teams**, and then select**Create a Team**.
7673
1. Enter the**Team Name**.
77-
>**NOTE**
78-
The team name can include only lower-case alphanumeric characters and hyphens, without spaces.
74+
>**NOTE**
75+
>The team name can include only lower-case alphanumeric characters and hyphens, without spaces.
7976
8077
See the screenshot below for some sample team names.
8178

@@ -89,19 +86,21 @@ Create a team in Codefresh and then assign users to the team. You can assign the
8986
%}
9087

9188
###Assign a user to a team
89+
9290
1. To assign users to the team, do the following:
93-
1. Hover over the team name and click the**Settings** icon.
91+
1. Hover over the team name and click the**Settings** icon.
9492
1. Click**Invite to team**, type the email address of the user to invite, and then click**Add**.
95-
1. To change the name of the team, click**Edit** and type the new name.
93+
1. To change the name of the team, click**Edit** and type the new name.
9694

9795
##Define session timeouts and domain restrictions for user accounts
96+
9897
As an administrator, you can optionally define session timeouts to automatically log out users who have been inactive for the specified duration, and restrict invitations to specific email domains.
9998

100-
>**NOTE**
101-
The maximum duration for inactivity is 30 days. Inactive users are warned 15 minutes before they are logged out.
99+
>**NOTE**
100+
>The maximum duration for inactivity is 30 days. Inactive users are warned 15 minutes before they are logged out.
102101
103102
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then select**Account Settings**.
104-
1. On the sidebar, from Access & Collaboration, select[**Users & Teams**](https://g.codefresh.io/account-admin/collaborators/users){:target="\_blank"}.
103+
1. On the sidebar, from Access & Collaboration, select[**Users & Teams**](https://g.codefresh.io/account-admin/collaborators/users){:target="\_blank"}.
105104
1. Select**Security**.
106105
1. For**User Session**, add the timeout duration in minutes/hours/days.
107106
1. To restrict invitations to specific email domains, below User Invitations, turn on**Restrict inviting additional users..** and then in the**Email domains**, type in the domains to allow, one per line.
@@ -115,12 +114,18 @@ As an administrator, you can optionally define session timeouts to automatically
115114
max-width="90%"
116115
%}
117116

118-
##Troubleshootadd users
117+
##Troubleshootuser invites
119118

120-
*[Account invitation not permitting login]({{site.baseurl}}/docs/kb/articles/account-invite-not-permitting-login/){:target="\_blank"}
121-
<!--this is already mentioned as inline refs; add other topics-->
119+
1. For your security and to ensure a smooth process, it's crucial that the email account you're logging in with is the same as the email address used for the invite.
120+
1. Log out of any previous sessions with the relevant identity provider and, if necessary, try a different browser or a private/incognito window.
121+
1. If you can log in but need help finding the inviting account, your user may be under multiple accounts. If this is the case, you can switch between available accounts via the user menu drop-down in the upper right-hand corner.
122+
1. If you are prompted to create an organization, you either logged in before you were invited to the account or logged in with a different email address than the invite.
123+
* Finish the account setup by entering a unique organization name (this creates a personal account).
124+
* Once logged in, click your username on the top right and see if you have access to the invited account.
125+
1. If this issue persists, please know that our support team is here for you.[Contact](https://support.codefresh.io/hc/en-us/requests/new) them with as many details as you have, and they will assist you promptly.
122126

123127
##Related articles
128+
124129
[Access control]({{site.baseurl}}/docs/administration/account-user-management/access-control/)
125130
[Single Sign on]({{site.baseurl}}/docs/administration/single-sign-on/)
126131
[Setting up OAuth authentication for Git providers]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup)

‎_docs/kb/articles/403-error-codefresh-cli-in-build.md‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎_docs/kb/articles/access-is-denied-when-using-a-clone-step.md‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎_docs/kb/articles/account-invite-not-permitting-login.md‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎_docs/kb/articles/acquire-webhook-information.md‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎_docs/kb/articles/codefresh-cli-error-403.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ kb: true
88
ht:false
99
common:false
1010
categories:[CLI]
11-
support-reviewed:2023-04-18 LG
11+
support-reviewed:2024-07-24 LG
1212
---
1313

1414
##Overview
@@ -17,7 +17,9 @@ When running the CLI to use Codefresh, it returns error 403: Permission Denied.
1717

1818
##Details
1919

20-
The API key does not have the correct access permissions, or your user doesnot have access. If the user does have correct access permissions, you may need to refresh the API key.
20+
The API key does not have the correct access permissions, or your user does not have access. If the user does have correct access permissions, you may need to refresh the API key.
21+
22+
If thishappen within a build, builds are ran with the user context of the user who started it. So if any Codefresh CLI commands within a build fails with a 403 error, that means the user who started the build does not have the permissions to run this command.
2123

2224
###Updating API Key
2325

@@ -31,8 +33,6 @@ The API key does not have the correct access permissions, or your user doesnot h
3133
>
3234
>If you have multiple contexts, specify this in your command above.`codefreshcauth create-context [name] --api-key <KEY>`
3335
34-
Contact one of your administrators if your user lacks access.
35-
36-
##Related Items
36+
###Update Permissions
3737

38-
[Codefresh CLI](https://codefresh-io.github.io/cli/)
38+
Contact one of your administrators if your user lacks access. As an account admin, make modifications to the user's team assignment and/or your account's permissions rules to grant the user access on relevant objects and actions.

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp